The general operations are as follows:
Members: these are the members from j.l.m's view but are structured along the kinds of this class.
Extra Members: these are members enclosed in an undocumented package-private type element, and may not be linkable (or documented), however, the members of such a type element may be documented, as if declared in the subtype, only if the enclosing type is not being documented by a filter such as -public, -protected, etc.
Visible Members: these are the members that are "visible" and available and should be documented, in a type element.
The basic rule for computation: when considering a type element, besides its immediate direct types and interfaces, the computation should not expand to any other type in the inheritance hierarchy.
This table generates all the data structures it needs for each type, as its own view, and will present some form of this to the doclet as and when required to.
| Modifier and Type | Class and Description |
|---|---|
| private class | |
| public static enum | |
| private class | |
| private static record | |
| private static record |
| Modifier and Type | Field and Description |
|---|---|
| private final Set | allSuperclasses
Tables for direct and indirect superclasses. |
| private final List | allSuperinterfaces
Tables for direct and indirect superinterfaces. |
| private final BaseConfiguration | |
| private final Map | |
| private final VisibleMemberCache | |
| private final BaseOptions | |
| private final Map | overriddenMethodTable
Maps a method m declared in |
| private final TypeElement | |
| private final Set | parents
Tables for direct superclass and direct superinterfaces. |
| private final Map | |
| private final TypeElement | te
The class or interface described by this table. |
| private final Utils | |
| private Map |
| Access | Constructor and Description |
|---|---|
| protected | VisibleMemberTable(TypeElement typeElement, BaseConfiguration configuration, VisibleMemberCache mcache)
|
| Modifier and Type | Method and Description |
|---|---|
| private void | addDocumentedAnnotations(Set<AnnotationMirror> annotations, List<? extends AnnotationMirror> annotationMirrors)
|
| private boolean | |
| private boolean | allowInheritedMethod(ExecutableElement inheritedMethod, Map<ExecutableElement, List<ExecutableElement>> overriddenByTable, VisibleMemberTable.
|
| private void | |
| private void | |
| private void | |
| pack-priv void | |
| private void | |
| private void | |
| private void | |
| public boolean | equals(Object obj)
Overrides java. Indicates whether some other object is "equal to" this one. |
| private Set | |
| private List | |
| public List | Returns: a list of all visible membersthe member kind kindReturns a list of all visible enclosed members of a type element, and inherited members. |
| private Set | |
| public TypeMirror | |
| public List | |
| private VisibleMemberTable. | |
| public List | Returns: a list of visible enclosed members in this typeReturns a list of visible enclosed members of given kind, declared in this type element, and does not include any inherited members or extra members. |
| public ExecutableElement | Returns: the method found ornullthe method to check e)Returns the method overridden by the provided method, or |
| public VariableElement | Returns: the field or null if absentthe method ee)Returns the field for a property identified by any of the methods for that property. |
| public ExecutableElement | Returns: the getter or null if absentthe method ee)Returns the getter method for a property identified by any of the methods for that property. |
| public ExecutableElement | Returns: the property method or null if absentthe method ee)Returns the property method for a property identified by any of the methods for that property. |
| public ExecutableElement | Returns: the setter or null if absentthe method ee)Returns the setter method for a property identified by any of the methods for that property. |
| public List | Returns: a list of visible enclosed membersthe member kind kind,the predicate used to filter the output p)Returns a list of visible enclosed members of a specified kind, filtered by the specified predicate. |
| public List | Returns: a list of visible enclosed membersthe member kind kindReturns a list of all enclosed members including any extra members. |
| public Set | Returns: the set of visible classes in this mapReturns a set of visible type elements in this type element's lineage. |
| public int | |
| public boolean | Returns: true if visible members are present.Returns true if this table contains visible members of any kind, including inherited members. |
| public boolean | Returns: true if visible members are present.Returns true if this table contains visible members of the specified kind, including inherited members. |
| private boolean | |
| private boolean | |
| private boolean | isMemberHidden(Element inheritedMember, VisibleMemberTable.
|
| private boolean | Returns: true if the specified method is NOT a simple override of some other method, otherwise falsethe method to check e)Returns true if the specified method is NOT a simple override of some other method, otherwise false. |
| private boolean | |
| private boolean | |
| private static <K, V> boolean |