Class DeprecatedAPIListBuilder
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.DeprecatedAPIListBuilder
Deprecated.
Build list of all the deprecated packages, classes, constructors, fields and methods.
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Deprecated.static final int
Deprecated.static final int
Deprecated.private final Configuration
Deprecated.static final int
Deprecated.Deprecated.List of deprecated type Lists.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.private final Utils
Deprecated. -
Constructor Summary
ConstructorsConstructorDescriptionDeprecatedAPIListBuilder
(Configuration configuration) Deprecated.Constructor. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
Deprecated.Build the sorted list of all the deprecated APIs in this run.private void
composeDeprecatedList
(List<Doc> list, MemberDoc[] members) Deprecated.Add the members into a single list of deprecated members.getList
(int type) Deprecated.Return the list of deprecated Doc objects of a given type.boolean
hasDocumentation
(int type) Deprecated.Return true if the list of a given type has size greater than 0.private void
Deprecated.Sort the deprecated lists for class kinds, fields, methods and constructors.
-
Field Details
-
NUM_TYPES
public static final int NUM_TYPESDeprecated.- See Also:
-
PACKAGE
public static final int PACKAGEDeprecated.- See Also:
-
INTERFACE
public static final int INTERFACEDeprecated.- See Also:
-
CLASS
public static final int CLASSDeprecated.- See Also:
-
ENUM
public static final int ENUMDeprecated.- See Also:
-
EXCEPTION
public static final int EXCEPTIONDeprecated.- See Also:
-
ERROR
public static final int ERRORDeprecated.- See Also:
-
ANNOTATION_TYPE
public static final int ANNOTATION_TYPEDeprecated.- See Also:
-
FIELD
public static final int FIELDDeprecated.- See Also:
-
METHOD
public static final int METHODDeprecated.- See Also:
-
CONSTRUCTOR
public static final int CONSTRUCTORDeprecated.- See Also:
-
ENUM_CONSTANT
public static final int ENUM_CONSTANTDeprecated.- See Also:
-
ANNOTATION_TYPE_MEMBER
public static final int ANNOTATION_TYPE_MEMBERDeprecated.- See Also:
-
deprecatedLists
Deprecated.List of deprecated type Lists. -
configuration
Deprecated. -
utils
Deprecated.
-
-
Constructor Details
-
DeprecatedAPIListBuilder
Deprecated.Constructor.- Parameters:
configuration
- the current configuration of the doclet
-
-
Method Details
-
buildDeprecatedAPIInfo
private void buildDeprecatedAPIInfo()Deprecated.Build the sorted list of all the deprecated APIs in this run. Build separate lists for deprecated packages, classes, constructors, methods and fields.- Parameters:
configuration
- the current configuration of the doclet.
-
composeDeprecatedList
Deprecated.Add the members into a single list of deprecated members.- Parameters:
list
- List of all the particular deprecated members, e.g. methods.members
- members to be added in the list.
-
sortDeprecatedLists
private void sortDeprecatedLists()Deprecated.Sort the deprecated lists for class kinds, fields, methods and constructors. -
getList
Deprecated.Return the list of deprecated Doc objects of a given type.- Parameters:
type
- the constant representing the type of list being returned.
-
hasDocumentation
public boolean hasDocumentation(int type) Deprecated.Return true if the list of a given type has size greater than 0.- Parameters:
type
- the type of list being checked.
-