Enum Class DocumentationTool.Location

java.lang.Object

java.lang.Enum<DocumentationTool.Location>

javax.tools.DocumentationTool.Location

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.

Since:

1.8

See Also:

Nested Class Summary

Nested classes/interfaces declared in class Enum

Enum.EnumDesc<E>

Modifier and Type	Class	Description
`static final class`	`Enum.EnumDesc<E extends Enum<E>>`	A nominal descriptor for an `enum` constant.

Enum Constant Summary

Enum Constant	Description
`DOCLET_PATH`	Location to search for doclets.
`DOCUMENTATION_OUTPUT`	Location of new documentation files.
`SNIPPET_PATH`	Location to search for snippets.
`TAGLET_PATH`	Location to search for taglets.

Method Summary

Modifier and Type	Method	Description
`String`	`getName()`	Returns the name of this location.
`boolean`	`isOutputLocation()`	Determines if this is an output location.
`static DocumentationTool.Location`	`valueOf(String name)`	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 Enum

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

Modifier and Type	Method	Description
`protected final Object`	`clone()`	Throws CloneNotSupportedException.
`final int`	`compareTo(DocumentationTool.Location o)`	Compares this enum with the specified object for order.
`final Optional<Enum.EnumDesc<DocumentationTool.Location>>`	`describeConstable()`	Returns an enum descriptor `EnumDesc` for this instance, if one can be constructed, or an empty `Optional` if one cannot be.
`final boolean`	`equals(Object other)`	Returns true if the specified object is equal to this enum constant.
`protected final void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization has been deprecated for removal.
`final Class<DocumentationTool.Location>`	`getDeclaringClass()`	Returns the Class object corresponding to this enum constant's enum type.
`final int`	`hashCode()`	Returns a hash code for this enum constant.
`final String`	`name()`	Returns the name of this enum constant, exactly as declared in its enum declaration.
`final int`	`ordinal()`	Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
`String`	`toString()`	Returns the name of this enum constant, as contained in the declaration.
`static <T extends Enum<T>> T`	`valueOf(Class<T> enumClass, String name)`	Returns the enum constant of the specified enum class with the specified name.

Methods declared in class Object

getClass, notify, notifyAll, wait, wait, wait

Modifier and Type	Method	Description
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Methods declared in interface JavaFileManager.Location

isModuleOrientedLocation

Modifier and Type	Method	Description
`default boolean`	`isModuleOrientedLocation()`	Indicates if this location is module-oriented location, and therefore expected to contain classes in a module/package/class hierarchy, as compared to a package-oriented location, which is expected to contain classes in a package/class hierarchy.

Enum Constant Details

DOCUMENTATION_OUTPUT

public static final DocumentationTool.Location DOCUMENTATION_OUTPUT

Location of new documentation files.

DOCLET_PATH

public static final DocumentationTool.Location DOCLET_PATH

Location to search for doclets.

TAGLET_PATH

public static final DocumentationTool.Location TAGLET_PATH

Location to search for taglets.

SNIPPET_PATH

public static final DocumentationTool.Location SNIPPET_PATH

Location to search for snippets.

Since:: 18

Method Details

values

public static DocumentationTool.Location[] 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 DocumentationTool.Location 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

getName

public String getName()

Description copied from interface: JavaFileManager.Location

Returns the name of this location.

Specified by:: getName in interface JavaFileManager.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 interface JavaFileManager.Location
Returns:: true if this is an output location, false otherwise

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.