| java.lang.Object
 com.sun.tools.doclets.internal.toolkit.util.VisibleMemberMap
| VisibleMemberMap | | public class VisibleMemberMap (Code) | | 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 code is not part of an API.
It is implementation that is subject to change.
Do not use it as an API
author:
Atul M Dambalkar
author:
Jamie Ho (rewrite) |
| Constructor Summary | |
| public | VisibleMemberMap(ClassDoc classdoc, int kind, boolean nodepr)
Construct a VisibleMemberMap of the given type for the given
class. |
| ANNOTATION_TYPE_MEMBER_OPTIONAL | | final public static int ANNOTATION_TYPE_MEMBER_OPTIONAL(Code) | | |
| ANNOTATION_TYPE_MEMBER_REQUIRED | | final public static int ANNOTATION_TYPE_MEMBER_REQUIRED(Code) | | |
| CONSTRUCTORS | | final public static int CONSTRUCTORS(Code) | | |
| ENUM_CONSTANTS | | final public static int ENUM_CONSTANTS(Code) | | |
| FIELDS | | final public static int FIELDS(Code) | | |
| INNERCLASSES | | final public static int INNERCLASSES(Code) | | |
| METHODS | | final public static int METHODS(Code) | | |
| NUM_MEMBER_TYPES | | final public static int NUM_MEMBER_TYPES(Code) | | The total number of member types is
.
|
| VisibleMemberMap | | public VisibleMemberMap(ClassDoc classdoc, int kind, boolean nodepr)(Code) | | Construct a VisibleMemberMap of the given type for the given
class. If nodepr is true, exclude the deprecated members from
the map.
Parameters:
classdoc - the class whose members are being mapped.
Parameters:
kind - the kind of member that is being mapped.
Parameters:
nodepr - if true, exclude the deprecated members from the map. |
| getLeafClassMembers | | public List getLeafClassMembers(Configuration configuration)(Code) | | 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:
configuation - the current configuration of the doclet. |
| getMembersFor | | public List getMembersFor(ClassDoc cd)(Code) | | Retrn the list of members for the given class.
Parameters:
cd - the class to retrieve the list of visible members for. the list of members for the given class. |
| getVisibleClassesList | | public List getVisibleClassesList()(Code) | | Return the list of visible classes in this map.
the list of visible classes in this map. |
| noVisibleMembers | | public boolean noVisibleMembers()(Code) | | Return true if this map has no visible members.
true if this map has no visible members. |
|
|