Module org.opengis.geoapi.conformance

Package org.opengis.geoapi.schema

Enum Class DocumentationStyle

Object

Enum<DocumentationStyle>

DocumentationStyle

All Implemented Interfaces:

Serializable, Comparable<DocumentationStyle>, Constable

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 of an upper-case one and do not finish with a period. Those documentation can be read verbatim, or transformed into sentences.

Since:

3.1

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NONE	Skip documentation.
SENTENCE	Transform documentation to sentences.
VERBATIM	Store documentation verbatim, without transforming them into sentences.

Method Summary

Modifier and Type	Method	Description
static DocumentationStyle	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DocumentationStyle[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final DocumentationStyle NONE

Skip documentation. The SchemaInformation.documentation(org.w3c.dom.Node) field will be null. 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 Details

values

public static DocumentationStyle[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DocumentationStyle valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null