Class VisibleMemberMap
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.VisibleMemberMap
-
@Deprecated public class VisibleMemberMap extends 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.
- Author:
- Atul M Dambalkar, Jamie Ho (rewrite)
-
-
Field Summary
Fields Modifier and Type Field Description static int
ANNOTATION_TYPE_FIELDS
Deprecated.static int
ANNOTATION_TYPE_MEMBER_OPTIONAL
Deprecated.static int
ANNOTATION_TYPE_MEMBER_REQUIRED
Deprecated.static int
CONSTRUCTORS
Deprecated.static int
ENUM_CONSTANTS
Deprecated.static int
FIELDS
Deprecated.static int
INNERCLASSES
Deprecated.static int
METHODS
Deprecated.static int
NUM_MEMBER_TYPES
Deprecated.The total number of member types is 9.static int
PROPERTIES
Deprecated.static String
STARTLEVEL
Deprecated.
-
Constructor Summary
Constructors Constructor Description VisibleMemberMap(ClassDoc classdoc, int kind, Configuration configuration)
Deprecated.Construct a VisibleMemberMap of the given type for the given class.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ProgramElementDoc
getGetterForProperty(ProgramElementDoc propertyMethod)
Deprecated.Returns the getter documentation belonging to the given property method.List<ProgramElementDoc>
getLeafClassMembers(Configuration configuration)
Deprecated.Return the visible members of the class being mapped.List<ProgramElementDoc>
getMembersFor(ClassDoc cd)
Deprecated.Retrn the list of members for the given class.ProgramElementDoc
getPropertyMemberDoc(ProgramElementDoc ped)
Deprecated.Returns the property field documentation belonging to the given member.ProgramElementDoc
getSetterForProperty(ProgramElementDoc propertyMethod)
Deprecated.Returns the setter documentation belonging to the given property method.List<ClassDoc>
getVisibleClassesList()
Deprecated.Return the list of visible classes in this map.boolean
noVisibleMembers()
Deprecated.Return true if this map has no visible members.
-
-
-
Field Detail
-
INNERCLASSES
public static final int INNERCLASSES
Deprecated.- See Also:
- Constant Field Values
-
ENUM_CONSTANTS
public static final int ENUM_CONSTANTS
Deprecated.- See Also:
- Constant Field Values
-
FIELDS
public static final int FIELDS
Deprecated.- See Also:
- Constant Field Values
-
CONSTRUCTORS
public static final int CONSTRUCTORS
Deprecated.- See Also:
- Constant Field Values
-
METHODS
public static final int METHODS
Deprecated.- See Also:
- Constant Field Values
-
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
-
PROPERTIES
public static final int PROPERTIES
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 String STARTLEVEL
Deprecated.- See Also:
- Constant Field Values
-
-
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 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.
-
getLeafClassMembers
public 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 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.
-
noVisibleMembers
public boolean noVisibleMembers()
Deprecated.Return true if this map has no visible members.- Returns:
- true if this map has no visible members.
-
-