Enum Class DocumentationPolicy
- All Implemented Interfaces:
Serializable,Comparable<DocumentationPolicy>,Constable
Describes how a resource should be documented.
- Author:
- cdivilly
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionOnly authorized users can see the documentationUse the default value from the enclosing elementThe resource is not documentedAny user can see the documentation -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic DocumentationPolicyReturns the enum constant of this class with the specified name.static DocumentationPolicy[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
PUBLIC
Any user can see the documentation -
AUTHORIZED
Only authorized users can see the documentation -
NONE
The resource is not documented -
INHERIT
Use the default value from the enclosing element
-
-
Field Details
-
DEFAULT
DefaultDocumentationPolicy
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-