- All Implemented Interfaces:
Serializable
,Comparable<DocletEnvironment.ModuleMode>
,Constable
- Enclosing interface:
- DocletEnvironment
public static enum DocletEnvironment.ModuleMode extends Enum<DocletEnvironment.ModuleMode>
The mode specifying the level of detail of module documentation.
-
Nested Class Summary
Nested classes/interfaces declared in class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
-
Method Summary
Modifier and Type Method Description static DocletEnvironment.ModuleMode
valueOf(String name)
Returns the enum constant of this type with the specified name.static DocletEnvironment.ModuleMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
API
Indicate API level documentation is required -
ALL
Indicate Detailed documentation is required
-
-
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
-