- All Implemented Interfaces:
Serializable
,Comparable<DocumentationTool.Location>
,Constable
,JavaFileManager.Location
- Enclosing interface:
DocumentationTool
public static enum DocumentationTool.Location
extends Enum<DocumentationTool.Location>
implements JavaFileManager.Location
Locations specific to
DocumentationTool
.- See Also:
-
Nested Class Summary
Nested classes/interfaces declared in class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionLocation to search for doclets.Location of new documentation files.Location to search for snippets.Location to search for taglets. -
Method Summary
Modifier and TypeMethodDescriptiongetName()
Returns the name of this location.boolean
Determines if this is an output location.static DocumentationTool.Location
Returns the enum constant of this class with the specified name.static DocumentationTool.Location[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.Methods declared in class java.lang.Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
Methods declared in interface javax.tools.JavaFileManager.Location
isModuleOrientedLocation
-
Enum Constant Details
-
DOCUMENTATION_OUTPUT
Location of new documentation files. -
DOCLET_PATH
Location to search for doclets. -
TAGLET_PATH
Location to search for taglets. -
SNIPPET_PATH
Location to search for snippets.
-
-
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
-
getName
Description copied from interface:JavaFileManager.Location
Returns the name of this location.- Specified by:
getName
in interfaceJavaFileManager.Location
- Returns:
- a name
-
isOutputLocation
public boolean isOutputLocation()Description copied from interface:JavaFileManager.Location
Determines if this is an output location. An output location is a location that is conventionally used for output.- Specified by:
isOutputLocation
in interfaceJavaFileManager.Location
- Returns:
- true if this is an output location, false otherwise
-