public static enum ParameterFormat.ContentLevel extends Enum<ParameterFormat.ContentLevel>
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.
Defined in the sis-referencing
module
Enum Constant and Description |
---|
BRIEF
A medium level of content which formats each parameter on a single line.
|
DETAILED
|
NAME_SUMMARY
Limits the content to names and aliases in a tabular format.
|
Modifier and Type | Method and Description |
---|---|
static ParameterFormat.ContentLevel |
valueOf(String name)
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.
|
public static final ParameterFormat.ContentLevel DETAILED
DefaultParameterDescriptorGroup
javadoc,
(augmented with parameter aliases) formatted at this level produces a text like below:
EPSG: Mercator (variant A) (9804) EPSG: Mercator (1SP) OGC: Mercator_1SP ╔══════════════════════════════════════╤════════╤════════════╤═══════════════╤═══════════════╗ ║ Name │ Type │ Obligation │ Value domain │ Default value ║ ╟──────────────────────────────────────┼────────┼────────────┼───────────────┼───────────────╢ ║ EPSG: Latitude of natural origin │ Double │ Mandatory │ [-80 … 84]° │ 0.0° ║ ║ OGC: latitude_of_origin │ │ │ │ ║ ╟──────────────────────────────────────┼────────┼────────────┼───────────────┼───────────────╢ ║ EPSG: Longitude of natural origin │ Double │ Mandatory │ [-180 … 180]° │ 0.0° ║ ║ OGC: central_meridian │ │ │ │ ║ ╟──────────────────────────────────────┼────────┼────────────┼───────────────┼───────────────╢ ║ EPSG: Scale factor at natural origin │ Double │ Mandatory │ (0 … ∞) │ 1.0 ║ ║ OGC: scale_factor │ │ │ │ ║ ╟──────────────────────────────────────┼────────┼────────────┼───────────────┼───────────────╢ ║ EPSG: False easting │ Double │ Mandatory │ (-∞ … ∞) m │ 0.0 m ║ ║ OGC: false_easting │ │ │ │ ║ ╟──────────────────────────────────────┼────────┼────────────┼───────────────┼───────────────╢ ║ EPSG: False northing │ Double │ Mandatory │ (-∞ … ∞) m │ 0.0 m ║ ║ OGC: false_northing │ │ │ │ ║ ╚══════════════════════════════════════╧════════╧════════════╧═══════════════╧═══════════════╝
public static final ParameterFormat.ContentLevel BRIEF
DefaultParameterDescriptorGroup
javadoc
formatted at this level produces a text like below:
EPSG: Mercator (variant A) ┌────────────────────────────────┬────────┬────────────┬───────────────┬───────────────┐ │ Name (EPSG) │ Type │ Obligation │ Value domain │ Default value │ ├────────────────────────────────┼────────┼────────────┼───────────────┼───────────────┤ │ Latitude of natural origin │ Double │ Mandatory │ [-80 … 84]° │ 0.0° │ │ Longitude of natural origin │ Double │ Mandatory │ [-180 … 180]° │ 0.0° │ │ Scale factor at natural origin │ Double │ Mandatory │ (0 … ∞) │ 1.0 │ │ False easting │ Double │ Mandatory │ (-∞ … ∞) m │ 0.0 m │ │ False northing │ Double │ Mandatory │ (-∞ … ∞) m │ 0.0 m │ └────────────────────────────────┴────────┴────────────┴───────────────┴───────────────┘
public static final ParameterFormat.ContentLevel NAME_SUMMARY
ParameterBuilder
javadoc
formatted at this level produces a text like below:
EPSG: Mercator (variant A) ┌────────────────────────────────┬────────────────────┐ │ EPSG │ OGC │ ├────────────────────────────────┼────────────────────┤ │ Latitude of natural origin │ latitude_of_origin │ │ Longitude of natural origin │ central_meridian │ │ Scale factor at natural origin │ scale_factor │ │ False easting │ false_easting │ │ False northing │ false_northing │ └────────────────────────────────┴────────────────────┘
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.
public static ParameterFormat.ContentLevel[] values()
for (ParameterFormat.ContentLevel c : ParameterFormat.ContentLevel.values()) System.out.println(c);
public static ParameterFormat.ContentLevel valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullCopyright © 2010–2015 The Apache Software Foundation. All rights reserved.