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

Class VisibleMemberMap.ClassMembers

java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.VisibleMemberMap.ClassMembers
Enclosing class:
VisibleMemberMap
private class VisibleMemberMap.ClassMembers extends Object
A data structure that represents the class members for a visible class.

  • Field Details

    • mappingClass

      private ClassDoc mappingClass
      The mapping class, whose inherited members are put in the members list.

    • members

      private List<ProgramElementDoc> members
      List of inherited members from the mapping class.

    • level

      private String level
      Level/Depth of inheritance.

    • pattern

      private final Pattern pattern

  • Constructor Details

    • ClassMembers

      private ClassMembers(ClassDoc mappingClass, String level)

  • Method Details

    • getMembers

      public List<ProgramElementDoc> getMembers()
      Return list of inherited members from mapping class.
      Returns:
      List Inherited members.

    • build

      private void build()

    • mapClass

      private void mapClass()

    • addMembers

      private void addMembers(ClassDoc fromClass)
      Get all the valid members from the mapping class. Get the list of members for the class to be included into(ctii), also get the level string for ctii. If mapping class member is not already in the inherited member list and if it is visible in the ctii and not overridden, put such a member in the inherited member list. Adjust member-level-map, class-map.

    • isTreatedAsPrivate

      private boolean isTreatedAsPrivate(ProgramElementDoc pgmelem)

    • memberIsVisible

      private boolean memberIsVisible(ProgramElementDoc pgmdoc)
      Is given doc item visible in given classdoc in terms fo inheritance? The given doc item is visible in the given classdoc if it is public or protected and if it is package-private if it's containing class is in the same package as the given classdoc.

    • getClassMembers

      private List<ProgramElementDoc> getClassMembers(ClassDoc cd, boolean filter)
      Return all available class members.

    • filter

      private AnnotationTypeElementDoc[] filter(AnnotationTypeDoc doc, boolean required)
      Filter the annotation type members and return either the required members or the optional members, depending on the value of the required parameter.
      Parameters:
      doc - The annotation type to process.
      required -
      Returns:
      the annotation type members and return either the required members or the optional members, depending on the value of the required parameter.

    • found

      private boolean found(List<ProgramElementDoc> list, ProgramElementDoc elem)

    • isOverridden

      private boolean isOverridden(ProgramElementDoc pgmdoc, String level)
      Is member overridden? The member is overridden if it is found in the same level hierarchy e.g. member at level "11" overrides member at level "111".

    • properties

      private ProgramElementDoc[] properties(ClassDoc cd, boolean filter)

    • addToPropertiesMap

      private void addToPropertiesMap(MethodDoc setter, MethodDoc getter, MethodDoc propertyMethod, FieldDoc field)

    • addToPropertiesMap

      private void addToPropertiesMap(ProgramElementDoc propertyMethod, ProgramElementDoc commentSource)

    • getterForField

      private MethodDoc getterForField(MethodDoc[] methods, MethodDoc propertyMethod)

    • setterForField

      private MethodDoc setterForField(MethodDoc[] methods, MethodDoc propertyMethod)

    • fieldForProperty

      private FieldDoc fieldForProperty(FieldDoc[] fields, MethodDoc property)

    • isPropertyMethod

      private boolean isPropertyMethod(MethodDoc method)

    • checkOnPropertiesTags

      private void checkOnPropertiesTags(MethodDoc[] members)

    • isPropertyGetterOrSetter

      private boolean isPropertyGetterOrSetter(MethodDoc[] members, MethodDoc methodDoc)