Package org.apache.sis.parameter
Enum ParameterFormat.ContentLevel
- All Implemented Interfaces:
Serializable
,Comparable<ParameterFormat.ContentLevel>
,java.lang.constant.Constable
- Enclosing class:
ParameterFormat
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
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionA medium level of content which formats each parameter on a single line.Limits the content to names and aliases in a tabular format. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic ParameterFormat.ContentLevel
Returns the enum constant of this type with the specified name.static ParameterFormat.ContentLevel[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
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 inDefaultParameterDescriptorGroup
javadoc, (augmented with parameter aliases) formatted at this level produces a text like below: -
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 inDefaultParameterDescriptorGroup
javadoc formatted at this level produces a text like below: -
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 inParameterBuilder
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
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
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 nameNullPointerException
- if the argument is null
-