Enum LinkInfoImpl.Kind
- java.lang.Object
-
- java.lang.Enum<LinkInfoImpl.Kind>
-
- gw.gosudoc.com.sun.tools.doclets.formats.html.LinkInfoImpl.Kind
-
- All Implemented Interfaces:
Serializable
,Comparable<LinkInfoImpl.Kind>
- Enclosing class:
- LinkInfoImpl
public static enum LinkInfoImpl.Kind extends Enum<LinkInfoImpl.Kind>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ALL_CLASSES_FRAME
Indicate that the link appears in a class list.ANNOTATION
Annotation link.CLASS
Indicate that the link appears in a class documentation.CLASS_HEADER
The header in the class documentation.CLASS_SIGNATURE
The signature in the class documentation.CLASS_SIGNATURE_PARENT_NAME
The signature in the class documentation (implements/extends portion).CLASS_TREE_PARENT
The parent nodes in the class tree.CLASS_USE
Indicate that the link appears in class use documentation.CLASS_USE_HEADER
Indicate that the link appears in class use documentation.CONSTANT_SUMMARY
Indicate that the link appears in constant value summary.DEFAULT
EXECUTABLE_MEMBER_PARAM
The type of a method/constructor parameter.FIELD_DOC_COPY
The header for field documentation copied from parent.IMPLEMENTED_CLASSES
Implemented class links.IMPLEMENTED_INTERFACES
Implemented interface links.INDEX
Indicate that the link appears in index documentation.MEMBER
Indicate that the link appears in member documentation.MEMBER_TYPE_PARAMS
The type parameters of a method or constructor.METHOD_DOC_COPY
The header for method documentation copied from parent.METHOD_OVERRIDES
Method "overrides" link.METHOD_SPECIFIED_BY
Method "specified by" link.PACKAGE
Indicate that the link appears in package documentation.PACKAGE_FRAME
Indicate that the link appears in a class list.PROPERTY_DOC_COPY
The header for property documentation copied from parent.RETURN_TYPE
The return type of a method.SEE_TAG
Indicate that the link appears in see tag documentation.SERIAL_MEMBER
Indicate that the link appears in serial member documentation.SERIALIZED_FORM
Indicate that the link appears in serialized form documentation.SUBCLASSES
Subclasses links.SUBINTERFACES
Subinterface links.SUMMARY_RETURN_TYPE
The return type of a method in a member summary.SUPER_INTERFACES
Super interface links.TREE
Indicate that the link appears in tree documentation.VALUE_TAG
Indicate that the link appears in value tag documentation.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static LinkInfoImpl.Kind
valueOf(String name)
Returns the enum constant of this type with the specified name.static LinkInfoImpl.Kind[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
DEFAULT
public static final LinkInfoImpl.Kind DEFAULT
-
ALL_CLASSES_FRAME
public static final LinkInfoImpl.Kind ALL_CLASSES_FRAME
Indicate that the link appears in a class list.
-
CLASS
public static final LinkInfoImpl.Kind CLASS
Indicate that the link appears in a class documentation.
-
MEMBER
public static final LinkInfoImpl.Kind MEMBER
Indicate that the link appears in member documentation.
-
CLASS_USE
public static final LinkInfoImpl.Kind CLASS_USE
Indicate that the link appears in class use documentation.
-
INDEX
public static final LinkInfoImpl.Kind INDEX
Indicate that the link appears in index documentation.
-
CONSTANT_SUMMARY
public static final LinkInfoImpl.Kind CONSTANT_SUMMARY
Indicate that the link appears in constant value summary.
-
SERIALIZED_FORM
public static final LinkInfoImpl.Kind SERIALIZED_FORM
Indicate that the link appears in serialized form documentation.
-
SERIAL_MEMBER
public static final LinkInfoImpl.Kind SERIAL_MEMBER
Indicate that the link appears in serial member documentation.
-
PACKAGE
public static final LinkInfoImpl.Kind PACKAGE
Indicate that the link appears in package documentation.
-
SEE_TAG
public static final LinkInfoImpl.Kind SEE_TAG
Indicate that the link appears in see tag documentation.
-
VALUE_TAG
public static final LinkInfoImpl.Kind VALUE_TAG
Indicate that the link appears in value tag documentation.
-
TREE
public static final LinkInfoImpl.Kind TREE
Indicate that the link appears in tree documentation.
-
PACKAGE_FRAME
public static final LinkInfoImpl.Kind PACKAGE_FRAME
Indicate that the link appears in a class list.
-
CLASS_HEADER
public static final LinkInfoImpl.Kind CLASS_HEADER
The header in the class documentation.
-
CLASS_SIGNATURE
public static final LinkInfoImpl.Kind CLASS_SIGNATURE
The signature in the class documentation.
-
RETURN_TYPE
public static final LinkInfoImpl.Kind RETURN_TYPE
The return type of a method.
-
SUMMARY_RETURN_TYPE
public static final LinkInfoImpl.Kind SUMMARY_RETURN_TYPE
The return type of a method in a member summary.
-
EXECUTABLE_MEMBER_PARAM
public static final LinkInfoImpl.Kind EXECUTABLE_MEMBER_PARAM
The type of a method/constructor parameter.
-
SUPER_INTERFACES
public static final LinkInfoImpl.Kind SUPER_INTERFACES
Super interface links.
-
IMPLEMENTED_INTERFACES
public static final LinkInfoImpl.Kind IMPLEMENTED_INTERFACES
Implemented interface links.
-
IMPLEMENTED_CLASSES
public static final LinkInfoImpl.Kind IMPLEMENTED_CLASSES
Implemented class links.
-
SUBINTERFACES
public static final LinkInfoImpl.Kind SUBINTERFACES
Subinterface links.
-
SUBCLASSES
public static final LinkInfoImpl.Kind SUBCLASSES
Subclasses links.
-
CLASS_SIGNATURE_PARENT_NAME
public static final LinkInfoImpl.Kind CLASS_SIGNATURE_PARENT_NAME
The signature in the class documentation (implements/extends portion).
-
METHOD_DOC_COPY
public static final LinkInfoImpl.Kind METHOD_DOC_COPY
The header for method documentation copied from parent.
-
METHOD_SPECIFIED_BY
public static final LinkInfoImpl.Kind METHOD_SPECIFIED_BY
Method "specified by" link.
-
METHOD_OVERRIDES
public static final LinkInfoImpl.Kind METHOD_OVERRIDES
Method "overrides" link.
-
ANNOTATION
public static final LinkInfoImpl.Kind ANNOTATION
Annotation link.
-
FIELD_DOC_COPY
public static final LinkInfoImpl.Kind FIELD_DOC_COPY
The header for field documentation copied from parent.
-
CLASS_TREE_PARENT
public static final LinkInfoImpl.Kind CLASS_TREE_PARENT
The parent nodes in the class tree.
-
MEMBER_TYPE_PARAMS
public static final LinkInfoImpl.Kind MEMBER_TYPE_PARAMS
The type parameters of a method or constructor.
-
CLASS_USE_HEADER
public static final LinkInfoImpl.Kind CLASS_USE_HEADER
Indicate that the link appears in class use documentation.
-
PROPERTY_DOC_COPY
public static final LinkInfoImpl.Kind PROPERTY_DOC_COPY
The header for property documentation copied from parent.
-
-
Method Detail
-
values
public static LinkInfoImpl.Kind[] 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 (LinkInfoImpl.Kind c : LinkInfoImpl.Kind.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static LinkInfoImpl.Kind 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 nameNullPointerException
- if the argument is null
-
-