restconf/restconf-nb/src/main/java/org/opendaylight/restconf/server/api/FormatParameters.java

   1 /*
   2  * Copyright (c) 2024 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.restconf.server.api;
   9
  10 import org.eclipse.jdt.annotation.NonNullByDefault;
  11 import org.opendaylight.restconf.api.query.PrettyPrintParam;
  12 import org.opendaylight.restconf.api.query.RestconfQueryParam;
  13 import org.opendaylight.yangtools.concepts.Immutable;
  14
  15 /**
  16  * The set of {@link RestconfQueryParam}s governing output formatting.
  17  */
  18 @NonNullByDefault
  19 public interface FormatParameters extends Immutable {
  20     /**
  21      * Return the {@link PrettyPrintParam} parameter.
  22      *
  23      * @return the {@link PrettyPrintParam} parameter
  24      */
  25     PrettyPrintParam prettyPrint();
  26 }