Class VisibleMemberMap
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.VisibleMemberMap
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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate class
Deprecated.Represents a class member.private class
Deprecated.A data structure that represents the class members for a visible class.private class
Deprecated. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Deprecated.static final int
Deprecated.static final int
Deprecated.private final ClassDoc
Deprecated.Type whose visible members are requested.private final Map<ClassDoc,
VisibleMemberMap.ClassMembers> Deprecated.Map of class and it's ClassMembers object.private static final Map<ProgramElementDoc,
ProgramElementDoc> Deprecated.private final Configuration
Deprecated.The configuration this VisibleMemberMap was created with.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.private static final Map<ProgramElementDoc,
VisibleMemberMap.GetterSetter> Deprecated.static final int
Deprecated.private final int
Deprecated.Member kind: InnerClasses/Fields/Methods?private final Map<Object,
Map<ProgramElementDoc, String>> Deprecated.Map for each member name on to a map which contains members with same name-signature.static final int
Deprecated.private boolean
Deprecated.static final int
Deprecated.The total number of member types is 9.static final int
Deprecated.private static final Map<ClassDoc,
ProgramElementDoc[]> Deprecated.static final String
Deprecated.private final Utils
Deprecated.Deprecated.List of ClassDoc objects for which ClassMembers objects are built. -
Constructor Summary
ConstructorsConstructorDescriptionVisibleMemberMap
(ClassDoc classdoc, int kind, Configuration configuration) Deprecated.Construct a VisibleMemberMap of the given type for the given class. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
fillMemberLevelMap
(List<ProgramElementDoc> list, String level) Deprecated.private VisibleMemberMap.ClassMember
getClassMember
(MethodDoc member) Deprecated.getGetterForProperty
(ProgramElementDoc propertyMethod) Deprecated.Returns the getter documentation belonging to the given property method.private List<ProgramElementDoc>
getInheritedPackagePrivateMethods
(Configuration configuration) Deprecated.Return the package private members inherited by the class.getLeafClassMembers
(Configuration configuration) Deprecated.Return the visible members of the class being mapped.private Object
Deprecated.Return the key to the member map for the given member.Deprecated.Retrn the list of members for the given class.Deprecated.Returns the property field documentation belonging to the given member.getSetterForProperty
(ProgramElementDoc propertyMethod) Deprecated.Returns the setter documentation belonging to the given property method.Deprecated.Return the list of visible classes in this map.boolean
Deprecated.Return true if this map has no visible members.private void
purgeMemberLevelMap
(List<ProgramElementDoc> list, String level) Deprecated.private void
Deprecated.Sort the given mixed list of classes and interfaces to a list of classes followed by interfaces traversed.
-
Field Details
-
noVisibleMembers
private boolean noVisibleMembersDeprecated. -
INNERCLASSES
public static final int INNERCLASSESDeprecated.- See Also:
-
ENUM_CONSTANTS
public static final int ENUM_CONSTANTSDeprecated.- See Also:
-
FIELDS
public static final int FIELDSDeprecated.- See Also:
-
CONSTRUCTORS
public static final int CONSTRUCTORSDeprecated.- See Also:
-
METHODS
public static final int METHODSDeprecated.- See Also:
-
ANNOTATION_TYPE_FIELDS
public static final int ANNOTATION_TYPE_FIELDSDeprecated.- See Also:
-
ANNOTATION_TYPE_MEMBER_OPTIONAL
public static final int ANNOTATION_TYPE_MEMBER_OPTIONALDeprecated.- See Also:
-
ANNOTATION_TYPE_MEMBER_REQUIRED
public static final int ANNOTATION_TYPE_MEMBER_REQUIREDDeprecated.- See Also:
-
PROPERTIES
public static final int PROPERTIESDeprecated.- See Also:
-
NUM_MEMBER_TYPES
public static final int NUM_MEMBER_TYPESDeprecated.The total number of member types is 9.- See Also:
-
STARTLEVEL
Deprecated.- See Also:
-
visibleClasses
Deprecated.List of ClassDoc objects for which ClassMembers objects are built. -
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. -
classMap
Deprecated.Map of class and it's ClassMembers object. -
classdoc
Deprecated.Type whose visible members are requested. This is the leaf of the class tree being mapped. -
kind
private final int kindDeprecated.Member kind: InnerClasses/Fields/Methods? -
configuration
Deprecated.The configuration this VisibleMemberMap was created with. -
utils
Deprecated. -
propertiesCache
Deprecated. -
classPropertiesMap
Deprecated. -
getterSetterMap
Deprecated.
-
-
Constructor Details
-
VisibleMemberMap
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 Details
-
getVisibleClassesList
Deprecated.Return the list of visible classes in this map.- Returns:
- the list of visible classes in this map.
-
getPropertyMemberDoc
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
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
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
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
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
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
Deprecated.Sort the given mixed list of classes and interfaces to a list of classes followed by interfaces traversed. Don't sort alphabetically. -
fillMemberLevelMap
Deprecated. -
purgeMemberLevelMap
Deprecated. -
noVisibleMembers
public boolean noVisibleMembers()Deprecated.Return true if this map has no visible members.- Returns:
- true if this map has no visible members.
-
getClassMember
Deprecated. -
getMemberKey
Deprecated.Return the key to the member map for the given member.
-