Enum Taglet.Location
- java.lang.Object
-
- java.lang.Enum<Taglet.Location>
-
- jdk.javadoc.doclet.Taglet.Location
- All Implemented Interfaces:
-
Serializable,Comparable<Taglet.Location>
- Enclosing interface:
- Taglet
public static enum Taglet.Location extends Enum<Taglet.Location>
The kind of location in which a tag may be used.
Enum Constants
| Enum Constant | Description |
|---|---|
CONSTRUCTOR | In the documentation for a constructor. |
FIELD | In the documentation for a field. |
METHOD | In the documentation for a method. |
MODULE | In the documentation for a module. |
OVERVIEW | In an Overview document. |
PACKAGE | In the documentation for a package. |
TYPE | In the documentation for a class, interface or enum. |
Methods
| Modifier and Type | Method | Description |
|---|---|---|
static Taglet.Location | valueOf(String name) | Returns the enum constant of this type with the specified name. |
static Taglet.Location[] | values() | Returns an array containing the constants of this enum type, in the order they are declared. |
Methods declared in class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf Methods declared in class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait Enum Constants
OVERVIEW
public static final Taglet.Location OVERVIEW
In an Overview document.
MODULE
public static final Taglet.Location MODULE
In the documentation for a module.
PACKAGE
public static final Taglet.Location PACKAGE
In the documentation for a package.
TYPE
public static final Taglet.Location TYPE
In the documentation for a class, interface or enum.
CONSTRUCTOR
public static final Taglet.Location CONSTRUCTOR
In the documentation for a constructor.
METHOD
public static final Taglet.Location METHOD
In the documentation for a method.
FIELD
public static final Taglet.Location FIELD
In the documentation for a field.
Methods
values
public static Taglet.Location[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (Taglet.Location c : Taglet.Location.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
valueOf
public static Taglet.Location valueOf(String name)
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 name -
NullPointerException- if the argument is null
© 1993, 2020, 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.
https://docs.oracle.com/en/java/javase/11/docs/api/jdk.javadoc/jdk/javadoc/doclet/Taglet.Location.html