- 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 SummaryNested classes/interfaces declared in class java.lang.EnumEnum.EnumDesc<E extends Enum<E>>
- 
Enum Constant SummaryEnum ConstantsEnum ConstantDescriptionLocation to search for doclets.Location of new documentation files.Location to search for snippets.Location to search for taglets.
- 
Method SummaryModifier and TypeMethodDescriptiongetName()Returns the name of this location.booleanDetermines if this is an output location.static DocumentationTool.LocationReturns 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.Enumclone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOfMethods declared in interface javax.tools.JavaFileManager.LocationisModuleOrientedLocation
- 
Enum Constant Details- 
DOCUMENTATION_OUTPUTLocation of new documentation files.
- 
DOCLET_PATHLocation to search for doclets.
- 
TAGLET_PATHLocation to search for taglets.
- 
SNIPPET_PATHLocation to search for snippets.
 
- 
- 
Method Details- 
valuesReturns 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
 
- 
valueOfReturns 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
 
- 
getNameDescription copied from interface:JavaFileManager.LocationReturns the name of this location.- Specified by:
- getNamein interface- JavaFileManager.Location
- Returns:
- a name
 
- 
isOutputLocationpublic boolean isOutputLocation()Description copied from interface:JavaFileManager.LocationDetermines if this is an output location. An output location is a location that is conventionally used for output.- Specified by:
- isOutputLocationin interface- JavaFileManager.Location
- Returns:
- true if this is an output location, false otherwise
 
 
-