Enum ParameterFormat.ContentLevel

java.lang.Object
java.lang.Enum<ParameterFormat.ContentLevel>
org.apache.sis.parameter.ParameterFormat.ContentLevel
All Implemented Interfaces:
Serializable, Comparable<ParameterFormat.ContentLevel>, java.lang.constant.Constable
Enclosing class:
ParameterFormat

public static enum ParameterFormat.ContentLevel extends Enum<ParameterFormat.ContentLevel>
The amount of information to include in the table formatted by ParameterFormat. The content level controls whether the formatter should write all names and aliases (at the cost of multi-line rows), or to pickup one name per parameter for a more compact table.

The enumeration value javadoc provide examples of formatting output.

Since:
0.4
Version:
0.4
  • Enum Constant Details

    • DETAILED

      public static final ParameterFormat.ContentLevel DETAILED
      The most detailed content, which includes name and aliases. Each parameter may be formatted on many lines if they have aliases.
      Example: The Mercator (variant A) example given in DefaultParameterDescriptorGroup javadoc, (augmented with parameter aliases) formatted at this level produces a text like below:
    • BRIEF

      public static final ParameterFormat.ContentLevel BRIEF
      A medium level of content which formats each parameter on a single line. For each parameter only the name is formatted — aliases and identifiers are omitted.
      Example: The Mercator (variant A) example given in DefaultParameterDescriptorGroup javadoc formatted at this level produces a text like below:
    • NAME_SUMMARY

      public static final ParameterFormat.ContentLevel NAME_SUMMARY
      Limits the content to names and aliases in a tabular format. In addition to parameters, this level can also format array of operation method, coordinate reference system, etc. The summary contains the identifier names and aliases aligned in a table.
      Example: The Mercator (variant A) example given in ParameterBuilder javadoc formatted at this level produces a text like below:

      Tip: the table formatted by default may be quite large. It is recommended to invoke ParameterFormat.setPreferredCodespaces(String[]) before to format in order to reduce the amount of columns to display.

  • Constructor Details

    • ContentLevel

      private ContentLevel()
  • Method Details

    • values

      public static ParameterFormat.ContentLevel[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static ParameterFormat.ContentLevel valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null