Enum LinkInfoImpl.Kind

    • Enum Constant Detail

      • 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.
      • 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.
      • 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 name
        NullPointerException - if the argument is null