Package gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util

Class VisibleMemberMap

  • @Deprecated
public class VisibleMemberMap
extends java.lang.Object
    Deprecated.
    A data structure that encapsulates the visible members of a particular type for a given class tree. To use this data structor, you must specify the type of member you are interested in (nested class, field, constructor or method) and the leaf of the class tree. The data structure will map all visible members in the leaf and classes above the leaf in the tree.

    This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

    • Field Detail

      • noVisibleMembers

        private boolean noVisibleMembers
        Deprecated.

      • ANNOTATION_TYPE_FIELDS

        public static final int ANNOTATION_TYPE_FIELDS
        Deprecated.
        See Also:
        Constant Field Values

      • ANNOTATION_TYPE_MEMBER_OPTIONAL

        public static final int ANNOTATION_TYPE_MEMBER_OPTIONAL
        Deprecated.
        See Also:
        Constant Field Values

      • ANNOTATION_TYPE_MEMBER_REQUIRED

        public static final int ANNOTATION_TYPE_MEMBER_REQUIRED
        Deprecated.
        See Also:
        Constant Field Values

      • NUM_MEMBER_TYPES

        public static final int NUM_MEMBER_TYPES
        Deprecated.
        The total number of member types is 9.
        See Also:
        Constant Field Values

      • STARTLEVEL

        public static final java.lang.String STARTLEVEL
        Deprecated.
        See Also:
        Constant Field Values

      • visibleClasses

        private final java.util.List<ClassDoc> visibleClasses
        Deprecated.
        List of ClassDoc objects for which ClassMembers objects are built.

      • memberNameMap

        private final java.util.Map<java.lang.Object,​java.util.Map<ProgramElementDoc,​java.lang.String>> memberNameMap
        Deprecated.
        Map for each member name on to a map which contains members with same name-signature. The mapped map will contain mapping for each MemberDoc onto it's respecive level string.

      • classdoc

        private final ClassDoc classdoc
        Deprecated.
        Type whose visible members are requested. This is the leaf of the class tree being mapped.

      • kind

        private final int kind
        Deprecated.
        Member kind: InnerClasses/Fields/Methods?

      • configuration

        private final Configuration configuration
        Deprecated.
        The configuration this VisibleMemberMap was created with.

      • utils

        private final Utils utils
        Deprecated.

    • Constructor Detail

      • VisibleMemberMap

        public VisibleMemberMap​(ClassDoc classdoc,
                        int kind,
                        Configuration configuration)
        Deprecated.
        Construct a VisibleMemberMap of the given type for the given class.
        Parameters:
        classdoc - the class whose members are being mapped.
        kind - the kind of member that is being mapped.
        configuration - the configuration to use to construct this VisibleMemberMap. If the field configuration.nodeprecated is true the deprecated members are excluded from the map. If the field configuration.javafx is true the JavaFX features are used.

    • Method Detail

      • getVisibleClassesList

        public java.util.List<ClassDoc> getVisibleClassesList()
        Deprecated.
        Return the list of visible classes in this map.
        Returns:
        the list of visible classes in this map.

      • getPropertyMemberDoc

        public ProgramElementDoc getPropertyMemberDoc​(ProgramElementDoc ped)
        Deprecated.
        Returns the property field documentation belonging to the given member.
        Parameters:
        ped - the member for which the property documentation is needed.
        Returns:
        the property field documentation, null if there is none.

      • getGetterForProperty

        public ProgramElementDoc getGetterForProperty​(ProgramElementDoc propertyMethod)
        Deprecated.
        Returns the getter documentation belonging to the given property method.
        Parameters:
        propertyMethod - the method for which the getter is needed.
        Returns:
        the getter documentation, null if there is none.

      • getSetterForProperty

        public ProgramElementDoc getSetterForProperty​(ProgramElementDoc propertyMethod)
        Deprecated.
        Returns the setter documentation belonging to the given property method.
        Parameters:
        propertyMethod - the method for which the setter is needed.
        Returns:
        the setter documentation, null if there is none.

      • getInheritedPackagePrivateMethods

        private java.util.List<ProgramElementDoc> getInheritedPackagePrivateMethods​(Configuration configuration)
        Deprecated.
        Return the package private members inherited by the class. Only return if parent is package private and not documented.
        Parameters:
        configuration - the current configuration of the doclet.
        Returns:
        the package private members inherited by the class.

      • getLeafClassMembers

        public java.util.List<ProgramElementDoc> getLeafClassMembers​(Configuration configuration)
        Deprecated.
        Return the visible members of the class being mapped. Also append at the end of the list members that are inherited by inaccessible parents. We document these members in the child because the parent is not documented.
        Parameters:
        configuration - the current configuration of the doclet.

      • getMembersFor

        public java.util.List<ProgramElementDoc> getMembersFor​(ClassDoc cd)
        Deprecated.
        Retrn the list of members for the given class.
        Parameters:
        cd - the class to retrieve the list of visible members for.
        Returns:
        the list of members for the given class.

      • sort

        private void sort​(java.util.List<ClassDoc> list)
        Deprecated.
        Sort the given mixed list of classes and interfaces to a list of classes followed by interfaces traversed. Don't sort alphabetically.

      • fillMemberLevelMap

        private void fillMemberLevelMap​(java.util.List<ProgramElementDoc> list,
                                java.lang.String level)
        Deprecated.

      • purgeMemberLevelMap

        private void purgeMemberLevelMap​(java.util.List<ProgramElementDoc> list,
                                 java.lang.String level)
        Deprecated.

      • noVisibleMembers

        public boolean noVisibleMembers()
        Deprecated.
        Return true if this map has no visible members.
        Returns:
        true if this map has no visible members.

      • getMemberKey

        private java.lang.Object getMemberKey​(ProgramElementDoc doc)
        Deprecated.
        Return the key to the member map for the given member.