Class 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)
    • 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.