Package org.opengis.geoapi
Enum DocumentationStyle
- Object
-
- Enum<DocumentationStyle>
-
- DocumentationStyle
-
- All Implemented Interfaces:
Serializable
,Comparable<DocumentationStyle>
public enum DocumentationStyle extends Enum<DocumentationStyle>
Style of the documentation to store. Documentation in XSD files are not sentence; they begin with a lower-case letter instead than an upper-case one and do not finish with a period. Those documentation can be read verbatim, or transformed into sentences.- Since:
- 3.1
-
-
Method Summary
Modifier and Type Method Description static DocumentationStyle
valueOf(String name)
Returns the enum constant of this type with the specified name.static DocumentationStyle[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
NONE
public static final DocumentationStyle NONE
Skip documentation. TheSchemaInformation.documentation(org.w3c.dom.Node)
field will benull
. This style can be used when documentation is not needed.
-
VERBATIM
public static final DocumentationStyle VERBATIM
Store documentation verbatim, without transforming them into sentences.
-
SENTENCE
public static final DocumentationStyle SENTENCE
Transform documentation to sentences.
-
-
Method Detail
-
values
public static DocumentationStyle[] 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 DocumentationStyle 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 nameNullPointerException
- if the argument is null
-
-