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

Class DeprecatedAPIListBuilder

java.lang.Object

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

@Deprecated
public class DeprecatedAPIListBuilder
extends java.lang.Object

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

Fields

Modifier and Type	Field	Description
static int	ANNOTATION_TYPE	Deprecated.
static int	ANNOTATION_TYPE_MEMBER	Deprecated.
static int	CLASS	Deprecated.
private Configuration	configuration	Deprecated.
static int	CONSTRUCTOR	Deprecated.
private java.util.List<java.util.List<Doc>>	deprecatedLists	Deprecated. List of deprecated type Lists.
static int	ENUM	Deprecated.
static int	ENUM_CONSTANT	Deprecated.
static int	ERROR	Deprecated.
static int	EXCEPTION	Deprecated.
static int	FIELD	Deprecated.
static int	INTERFACE	Deprecated.
static int	METHOD	Deprecated.
static int	NUM_TYPES	Deprecated.
static int	PACKAGE	Deprecated.
private Utils	utils	Deprecated.

Constructor Summary

Constructors

Constructor	Description
DeprecatedAPIListBuilder(Configuration configuration)	Deprecated. Constructor.

Method Summary

Modifier and Type	Method	Description
private void	buildDeprecatedAPIInfo()	Deprecated. Build the sorted list of all the deprecated APIs in this run.
private void	composeDeprecatedList(java.util.List<Doc> list, MemberDoc[] members)	Deprecated. Add the members into a single list of deprecated members.
java.util.List<Doc>	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	sortDeprecatedLists()	Deprecated. Sort the deprecated lists for class kinds, fields, methods and constructors.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NUM_TYPES

public static final int NUM_TYPES

Deprecated.

See Also:

Constant Field Values

PACKAGE

public static final int PACKAGE

Deprecated.

See Also:

Constant Field Values

INTERFACE

public static final int INTERFACE

Deprecated.

See Also:

Constant Field Values

CLASS

public static final int CLASS

Deprecated.

See Also:

Constant Field Values

ENUM

public static final int ENUM

Deprecated.

See Also:

Constant Field Values

EXCEPTION

public static final int EXCEPTION

Deprecated.

See Also:

Constant Field Values

ERROR

public static final int ERROR

Deprecated.

See Also:

Constant Field Values

ANNOTATION_TYPE

public static final int ANNOTATION_TYPE

Deprecated.

See Also:

Constant Field Values

FIELD

public static final int FIELD

Deprecated.

See Also:

Constant Field Values

METHOD

public static final int METHOD

Deprecated.

See Also:

Constant Field Values

CONSTRUCTOR

public static final int CONSTRUCTOR

Deprecated.

See Also:

Constant Field Values

ENUM_CONSTANT

public static final int ENUM_CONSTANT

Deprecated.

See Also:

Constant Field Values

ANNOTATION_TYPE_MEMBER

public static final int ANNOTATION_TYPE_MEMBER

Deprecated.

See Also:

Constant Field Values

deprecatedLists

private java.util.List<java.util.List<Doc>> deprecatedLists

Deprecated.

List of deprecated type Lists.

configuration

private final Configuration configuration

Deprecated.

utils

private final Utils utils

Deprecated.

Constructor Detail

DeprecatedAPIListBuilder

public DeprecatedAPIListBuilder(Configuration configuration)

Deprecated.

Constructor.

Parameters:

configuration - the current configuration of the doclet

Method Detail

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

private void composeDeprecatedList(java.util.List<Doc> list,
                                   MemberDoc[] members)

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

public java.util.List<Doc> getList(int type)

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.