A

allClasses(boolean) - Method in interface com.sun.javadoc.PackageDoc

Get all classes and interfaces in the package, filtered to the specified access modifier option.

allClasses() - Method in interface com.sun.javadoc.PackageDoc

Get all included classes and interfaces in the package.

AnnotationDesc - Interface in com.sun.javadoc

Represents an annotation.

AnnotationDesc.ElementValuePair - Interface in com.sun.javadoc

Represents an association between an annotation type element and one of its values.

annotations() - Method in interface com.sun.javadoc.PackageDoc

Get the annotations of this package.

annotations() - Method in interface com.sun.javadoc.Parameter

Get the annotations of this parameter.

annotations() - Method in interface com.sun.javadoc.ProgramElementDoc

Get the annotations of this program element.

annotationType() - Method in interface com.sun.javadoc.AnnotationDesc

Returns the annotation type of this annotation.

AnnotationTypeDoc - Interface in com.sun.javadoc

Represents an annotation type.

AnnotationTypeElementDoc - Interface in com.sun.javadoc

Represents an element of an annotation type.

annotationTypes() - Method in interface com.sun.javadoc.PackageDoc

Get included annotation types in this package.

AnnotationValue - Interface in com.sun.javadoc

Represents a value of an annotation type element.

asAnnotationTypeDoc() - Method in interface com.sun.javadoc.Type

Return this type as an AnnotationTypeDoc if it represents an annotation type.

asClassDoc() - Method in interface com.sun.javadoc.ParameterizedType

Return the generic class or interface that declared this type.

asClassDoc() - Method in interface com.sun.javadoc.Type

Return this type as a ClassDoc if it represents a class or interface.

asParameterizedType() - Method in interface com.sun.javadoc.Type

Return this type as a ParameterizedType if it represents an invocation of a generic class or interface.

asTypeVariable() - Method in interface com.sun.javadoc.Type

Return this type as a TypeVariable if it represents a type variable.

asWildcardType() - Method in interface com.sun.javadoc.Type

Return this type as a WildcardType if it represents a wildcard type.

B

bounds() - Method in interface com.sun.javadoc.TypeVariable

Return the bounds of this type variable.

C

ClassDoc - Interface in com.sun.javadoc

Represents a java class or interface and provides access to information about the class, the class's comment and tags, and the members of the class.

classes() - Method in interface com.sun.javadoc.RootDoc

Return the included classes and interfaces in all packages.

classNamed(String) - Method in interface com.sun.javadoc.RootDoc

Return a ClassDoc for the specified class or interface name.

column() - Method in interface com.sun.javadoc.SourcePosition

The column in the source file.

com.sun.javadoc - package com.sun.javadoc

The Doclet API (also called the Javadoc API) provides a mechanism for clients to inspect the source-level structure of programs and libraries, including javadoc comments embedded in the source.

commentText() - Method in interface com.sun.javadoc.Doc

Return the text of the comment for this doc item.

compareTo(Object) - Method in interface com.sun.javadoc.Doc

Compares this doc object with the specified object for order.

compareTo(Object) - Method in interface com.sun.javadoc.SerialFieldTag

Compares this Object with the specified Object for order.

constantValue() - Method in interface com.sun.javadoc.FieldDoc

Get the value of a constant field.

constantValueExpression() - Method in interface com.sun.javadoc.FieldDoc

Get the value of a constant field.

ConstructorDoc - Interface in com.sun.javadoc

Represents a constructor of a java class.

constructors() - Method in interface com.sun.javadoc.ClassDoc

Return included constructors in this class.

constructors(boolean) - Method in interface com.sun.javadoc.ClassDoc

Return constructors in this class, filtered to the specified access modifier option.

containingClass() - Method in interface com.sun.javadoc.ProgramElementDoc

Get the containing class or interface of this program element.

containingPackage() - Method in interface com.sun.javadoc.ProgramElementDoc

Get the package that this program element is contained in.

containingType() - Method in interface com.sun.javadoc.ParameterizedType

Return the type that contains this type as a member.

D

defaultValue() - Method in interface com.sun.javadoc.AnnotationTypeElementDoc

Returns the default value of this element.

definesSerializableFields() - Method in interface com.sun.javadoc.ClassDoc

Return true if Serializable fields are explicitly defined with the special class member serialPersistentFields.

description() - Method in interface com.sun.javadoc.SerialFieldTag

Return the field comment.

dimension() - Method in interface com.sun.javadoc.Type

Return the type's dimension information, as a string.

Doc - Interface in com.sun.javadoc

Represents Java language constructs (package, class, constructor, method, field) which have comments and have been processed by this run of javadoc.

DocErrorReporter - Interface in com.sun.javadoc

This interface provides error, warning and notice printing.

Doclet - Class in com.sun.javadoc

This is an example of a starting class for a doclet, showing the entry-point methods.

Doclet() - Constructor for class com.sun.javadoc.Doclet

 

E

element() - Method in interface com.sun.javadoc.AnnotationDesc.ElementValuePair

Returns the annotation type element.

elements() - Method in interface com.sun.javadoc.AnnotationTypeDoc

Returns the elements of this annotation type.

elementValues() - Method in interface com.sun.javadoc.AnnotationDesc

Returns this annotation's elements and their values.

enumConstants() - Method in interface com.sun.javadoc.ClassDoc

Return the enum constants if this is an enum type.

enums() - Method in interface com.sun.javadoc.PackageDoc

Get included enum types in this package.

errors() - Method in interface com.sun.javadoc.PackageDoc

Get included Error classes in this package.

exception() - Method in interface com.sun.javadoc.ThrowsTag

Return a ClassDoc that represents the exception.

exceptionComment() - Method in interface com.sun.javadoc.ThrowsTag

Return the exception comment associated with this ThrowsTag.

exceptionName() - Method in interface com.sun.javadoc.ThrowsTag

Return the name of the exception associated with this ThrowsTag.

exceptions() - Method in interface com.sun.javadoc.PackageDoc

Get included Exception classes in this package.

exceptionType() - Method in interface com.sun.javadoc.ThrowsTag

Return the type of the exception associated with this ThrowsTag.

ExecutableMemberDoc - Interface in com.sun.javadoc

Represents a method or constructor of a java class.

extendsBounds() - Method in interface com.sun.javadoc.WildcardType

Return the upper bounds of this wildcard type argument as given by the extends clause.

F

FieldDoc - Interface in com.sun.javadoc

Represents a field in a java class.

fieldName() - Method in interface com.sun.javadoc.SerialFieldTag

Return the serialziable field name.

fields() - Method in interface com.sun.javadoc.ClassDoc

Return included fields in this class or interface.

fields(boolean) - Method in interface com.sun.javadoc.ClassDoc

Return fields in this class or interface, filtered to the specified access modifier option.

fieldType() - Method in interface com.sun.javadoc.SerialFieldTag

Return the field type string.

fieldTypeDoc() - Method in interface com.sun.javadoc.SerialFieldTag

Return the ClassDoc for field type.

file() - Method in interface com.sun.javadoc.SourcePosition

The source file.

findClass(String) - Method in interface com.sun.javadoc.ClassDoc

Find the specified class or interface within the context of this class doc.

findClass(String) - Method in interface com.sun.javadoc.PackageDoc

Lookup a class or interface within this package.

firstSentenceTags() - Method in interface com.sun.javadoc.Doc

Return the first sentence of the comment as an array of tags.

firstSentenceTags() - Method in interface com.sun.javadoc.Tag

Return the first sentence of the comment as an array of tags.

flatSignature() - Method in interface com.sun.javadoc.ExecutableMemberDoc

get flat signature.

G

getRawCommentText() - Method in interface com.sun.javadoc.Doc

Return the full unprocessed text of the comment.

H

holder() - Method in interface com.sun.javadoc.Tag

Return the containing Doc of this Tag element.

I

importedClasses() - Method in interface com.sun.javadoc.ClassDoc

Deprecated.

Import declarations are implementation details that should not be exposed here. In addition, not all imported classes are imported through single-type-import declarations.

importedPackages() - Method in interface com.sun.javadoc.ClassDoc

Deprecated.

Import declarations are implementation details that should not be exposed here. In addition, this method's return type does not allow for all type-import-on-demand declarations to be returned.

inlineTags() - Method in interface com.sun.javadoc.Doc

Return comment as an array of tags.

inlineTags() - Method in interface com.sun.javadoc.Tag

For a documentation comment with embedded {@link} tags, return an array of Tag objects.

innerClasses() - Method in interface com.sun.javadoc.ClassDoc

Return included nested classes and interfaces within this class or interface.

innerClasses(boolean) - Method in interface com.sun.javadoc.ClassDoc

Return nested classes and interfaces within this class or interface filtered to the specified access modifier option.

interfaces() - Method in interface com.sun.javadoc.ClassDoc

Return interfaces implemented by this class or interfaces extended by this interface.

interfaces() - Method in interface com.sun.javadoc.PackageDoc

Get included interfaces in this package, omitting annotation types.

interfaceTypes() - Method in interface com.sun.javadoc.ClassDoc

Return interfaces implemented by this class or interfaces extended by this interface.

interfaceTypes() - Method in interface com.sun.javadoc.ParameterizedType

Return the interface types directly implemented by or extended by this parameterized type.

isAbstract() - Method in interface com.sun.javadoc.ClassDoc

Return true if this class is abstract.

isAbstract() - Method in interface com.sun.javadoc.MethodDoc

Return true if this method is abstract

isAnnotationType() - Method in interface com.sun.javadoc.Doc

Is this Doc item an annotation type?

isAnnotationTypeElement() - Method in interface com.sun.javadoc.Doc

Is this Doc item an annotation type element?

isClass() - Method in interface com.sun.javadoc.Doc

Is this Doc item a class (and not an interface or annotation type)?

isConstructor() - Method in interface com.sun.javadoc.Doc

Is this Doc item a constructor?

isEnum() - Method in interface com.sun.javadoc.Doc

Is this Doc item an enum type?

isEnumConstant() - Method in interface com.sun.javadoc.Doc

Is this Doc item an enum constant?

isError() - Method in interface com.sun.javadoc.Doc

Is this Doc item an error class?

isException() - Method in interface com.sun.javadoc.Doc

Is this Doc item an exception class?

isExternalizable() - Method in interface com.sun.javadoc.ClassDoc

Return true if this class implements or interface extends java.io.Externalizable.

isField() - Method in interface com.sun.javadoc.Doc

Is this Doc item a field (but not an enum constant)?

isFinal() - Method in interface com.sun.javadoc.ProgramElementDoc

Return true if this program element is final.

isIncluded() - Method in interface com.sun.javadoc.Doc

Return true if this Doc item is included in the result set.

isInterface() - Method in interface com.sun.javadoc.Doc

Is this Doc item an interface (but not an annotation type)?

isMethod() - Method in interface com.sun.javadoc.Doc

Is this Doc item a method (but not a constructor or annotation type element)?

isNative() - Method in interface com.sun.javadoc.ExecutableMemberDoc

Return true if this method is native

isOrdinaryClass() - Method in interface com.sun.javadoc.Doc

Is this Doc item an ordinary class?

isPackagePrivate() - Method in interface com.sun.javadoc.ProgramElementDoc

Return true if this program element is package private.

isPrimitive() - Method in interface com.sun.javadoc.Type

Return true if this type represents a primitive type.

isPrivate() - Method in interface com.sun.javadoc.ProgramElementDoc

Return true if this program element is private.

isProtected() - Method in interface com.sun.javadoc.ProgramElementDoc

Return true if this program element is protected.

isPublic() - Method in interface com.sun.javadoc.ProgramElementDoc

Return true if this program element is public.

isSerializable() - Method in interface com.sun.javadoc.ClassDoc

Return true if this class implements or interface extends java.io.Serializable.

isStatic() - Method in interface com.sun.javadoc.ProgramElementDoc

Return true if this program element is static.

isSynchronized() - Method in interface com.sun.javadoc.ExecutableMemberDoc

Return true if this method is synchronized

isSynthetic() - Method in interface com.sun.javadoc.MemberDoc

Returns true if this member was synthesized by the compiler.

isTransient() - Method in interface com.sun.javadoc.FieldDoc

Return true if this field is transient

isTypeParameter() - Method in interface com.sun.javadoc.ParamTag

Return true if this ParamTag corresponds to a type parameter.

isVarArgs() - Method in interface com.sun.javadoc.ExecutableMemberDoc

Return true if this method was declared to take a variable number of arguments.

isVolatile() - Method in interface com.sun.javadoc.FieldDoc

Return true if this field is volatile

K

kind() - Method in interface com.sun.javadoc.Tag

Return the kind of this tag.

L

label() - Method in interface com.sun.javadoc.SeeTag

Get the label of the @see tag.

languageVersion() - Static method in class com.sun.javadoc.Doclet

Return the version of the Java Programming Language supported by this doclet.

LanguageVersion - Enum in com.sun.javadoc

Java Programming Language version.

line() - Method in interface com.sun.javadoc.SourcePosition

The line in the source file.

M

MemberDoc - Interface in com.sun.javadoc

Represents a member of a java class: field, constructor, or method.

MethodDoc - Interface in com.sun.javadoc

Represents a method of a java class.

methods() - Method in interface com.sun.javadoc.ClassDoc

Return included methods in this class or interface.

methods(boolean) - Method in interface com.sun.javadoc.ClassDoc

Return methods in this class or interface, filtered to the specified access modifier option.

modifiers() - Method in interface com.sun.javadoc.ProgramElementDoc

Get modifiers string.

modifierSpecifier() - Method in interface com.sun.javadoc.ProgramElementDoc

Get the modifier specifier integer.

N

name() - Method in interface com.sun.javadoc.Doc

Returns the non-qualified name of this Doc item.

name() - Method in interface com.sun.javadoc.Parameter

Get local name of this parameter.

name() - Method in interface com.sun.javadoc.Tag

Return the name of this tag.

O

optionLength(String) - Static method in class com.sun.javadoc.Doclet

Check for doclet-added options.

options() - Method in interface com.sun.javadoc.RootDoc

Command line options.

ordinaryClasses() - Method in interface com.sun.javadoc.PackageDoc

Get included ordinary classes (that is, exclude exceptions, errors, enums, interfaces, and annotation types) in this package.

overriddenClass() - Method in interface com.sun.javadoc.MethodDoc

Return the class containing the method that this method overrides.

overriddenMethod() - Method in interface com.sun.javadoc.MethodDoc

Return the method that this method overrides.

overriddenType() - Method in interface com.sun.javadoc.MethodDoc

Return the type containing the method that this method overrides.

overrides(MethodDoc) - Method in interface com.sun.javadoc.MethodDoc

Tests whether this method overrides another.

owner() - Method in interface com.sun.javadoc.TypeVariable

Return the class, interface, method, or constructor within which this type variable is declared.

P

PackageDoc - Interface in com.sun.javadoc

Represents a java package.

packageNamed(String) - Method in interface com.sun.javadoc.RootDoc

Return a PackageDoc for the specified package name.

Parameter - Interface in com.sun.javadoc

Parameter information.

parameterComment() - Method in interface com.sun.javadoc.ParamTag

Return the parameter comment associated with this ParamTag.

ParameterizedType - Interface in com.sun.javadoc

Represents an invocation of a generic class or interface.

parameterName() - Method in interface com.sun.javadoc.ParamTag

Return the name of the parameter or type parameter associated with this ParamTag.

parameters() - Method in interface com.sun.javadoc.ExecutableMemberDoc

Get argument information.

ParamTag - Interface in com.sun.javadoc

Represents an @param documentation tag.

paramTags() - Method in interface com.sun.javadoc.ExecutableMemberDoc

Return the param tags in this method, excluding the type parameter tags.

position() - Method in interface com.sun.javadoc.Doc

Return the source position of the first line of the corresponding declaration, or null if no position is available.

position() - Method in interface com.sun.javadoc.Tag

Return the source position of this tag.

printError(String) - Method in interface com.sun.javadoc.DocErrorReporter

Print error message and increment error count.

printError(SourcePosition, String) - Method in interface com.sun.javadoc.DocErrorReporter

Print an error message and increment error count.

printNotice(String) - Method in interface com.sun.javadoc.DocErrorReporter

Print a message.

printNotice(SourcePosition, String) - Method in interface com.sun.javadoc.DocErrorReporter

Print a message.

printWarning(String) - Method in interface com.sun.javadoc.DocErrorReporter

Print warning message and increment warning count.

printWarning(SourcePosition, String) - Method in interface com.sun.javadoc.DocErrorReporter

Print warning message and increment warning count.

ProgramElementDoc - Interface in com.sun.javadoc

Represents a java program element: class, interface, field, constructor, or method.

Q

qualifiedName() - Method in interface com.sun.javadoc.ProgramElementDoc

Get the fully qualified name of this program element.

qualifiedTypeName() - Method in interface com.sun.javadoc.Type

Return qualified name of type excluding any dimension information.

R

referencedClass() - Method in interface com.sun.javadoc.SeeTag

Get the class doc referenced by the class name part of @see.

referencedClassName() - Method in interface com.sun.javadoc.SeeTag

Get the class or interface name of the @see reference.

referencedMember() - Method in interface com.sun.javadoc.SeeTag

Get the member doc for the field, constructor or method referenced by @see.

referencedMemberName() - Method in interface com.sun.javadoc.SeeTag

Get the field, constructor or method substring of the @see reference.

referencedPackage() - Method in interface com.sun.javadoc.SeeTag

Get the package doc when @see references only a package.

returnType() - Method in interface com.sun.javadoc.MethodDoc

Get return type.

RootDoc - Interface in com.sun.javadoc

Represents the root of the program structure information for one run of javadoc.

S

SeeTag - Interface in com.sun.javadoc

Represents a user-defined cross-reference to related documentation.

seeTags() - Method in interface com.sun.javadoc.Doc

Return the see also tags in this Doc item.

SerialFieldTag - Interface in com.sun.javadoc

Documents a Serializable field defined by an ObjectStreamField.

serialFieldTags() - Method in interface com.sun.javadoc.FieldDoc

Return the serialField tags in this FieldDoc item.

serializableFields() - Method in interface com.sun.javadoc.ClassDoc

Return the Serializable fields of this class or interface.

serializationMethods() - Method in interface com.sun.javadoc.ClassDoc

Return the serialization methods for this class or interface.

setRawCommentText(String) - Method in interface com.sun.javadoc.Doc

Set the full unprocessed text of the comment.

signature() - Method in interface com.sun.javadoc.ExecutableMemberDoc

Get the signature.

simpleTypeName() - Method in interface com.sun.javadoc.Type

Return the simple name of this type excluding any dimension information.

SourcePosition - Interface in com.sun.javadoc

This interface describes a source position: filename, line number, and column number.

specifiedClasses() - Method in interface com.sun.javadoc.RootDoc

Return the classes and interfaces specified as source file names on the command line.

specifiedPackages() - Method in interface com.sun.javadoc.RootDoc

Return the packages specified on the command line.

start(RootDoc) - Static method in class com.sun.javadoc.Doclet

Generate documentation here.

subclassOf(ClassDoc) - Method in interface com.sun.javadoc.ClassDoc

Test whether this class is a subclass of the specified class.

superBounds() - Method in interface com.sun.javadoc.WildcardType

Return the lower bounds of this wildcard type argument as given by the super clause.

superclass() - Method in interface com.sun.javadoc.ClassDoc

Return the superclass of this class.

superclassType() - Method in interface com.sun.javadoc.ClassDoc

Return the superclass of this class.

superclassType() - Method in interface com.sun.javadoc.ParameterizedType

Return the class type that is a direct supertype of this one.

T

Tag - Interface in com.sun.javadoc

Represents a simple documentation tag, such as @since, @author, @version.

tags() - Method in interface com.sun.javadoc.Doc

Return all tags in this Doc item.

tags(String) - Method in interface com.sun.javadoc.Doc

Return tags of the specified kind in this Doc item.

text() - Method in interface com.sun.javadoc.Tag

Return the text of this tag, that is, portion beyond tag name.

thrownExceptions() - Method in interface com.sun.javadoc.ExecutableMemberDoc

Return exceptions this method or constructor throws.

thrownExceptionTypes() - Method in interface com.sun.javadoc.ExecutableMemberDoc

Return exceptions this method or constructor throws.

ThrowsTag - Interface in com.sun.javadoc

Represents a @throws or @exception documentation tag.

throwsTags() - Method in interface com.sun.javadoc.ExecutableMemberDoc

Return the throws tags in this method.

toString() - Method in interface com.sun.javadoc.AnnotationValue

Returns a string representation of the value.

toString() - Method in interface com.sun.javadoc.Parameter

Returns a string representation of the parameter.

toString() - Method in interface com.sun.javadoc.SourcePosition

Convert the source position to the form "Filename:line".

toString() - Method in interface com.sun.javadoc.Tag

Convert this object to a string.

toString() - Method in interface com.sun.javadoc.Type

Return a string representation of the type.

type() - Method in interface com.sun.javadoc.FieldDoc

Get type of this field.

type() - Method in interface com.sun.javadoc.Parameter

Get the type of this parameter.

Type - Interface in com.sun.javadoc

Represents a type.

typeArguments() - Method in interface com.sun.javadoc.ParameterizedType

Return the actual type arguments of this type.

typeName() - Method in interface com.sun.javadoc.Parameter

Get type name of this parameter.

typeName() - Method in interface com.sun.javadoc.Type

Return unqualified name of type excluding any dimension information.

typeParameters() - Method in interface com.sun.javadoc.ClassDoc

Return the formal type parameters of this class or interface.

typeParameters() - Method in interface com.sun.javadoc.ExecutableMemberDoc

Return the formal type parameters of this method or constructor.

typeParamTags() - Method in interface com.sun.javadoc.ClassDoc

Return the type parameter tags of this class or interface.

typeParamTags() - Method in interface com.sun.javadoc.ExecutableMemberDoc

Return the type parameter tags in this method.

TypeVariable - Interface in com.sun.javadoc

Represents a type variable.

V

validOptions(String[][], DocErrorReporter) - Static method in class com.sun.javadoc.Doclet

Check that options have the correct arguments.

value() - Method in interface com.sun.javadoc.AnnotationDesc.ElementValuePair

Returns the value associated with the annotation type element.

value() - Method in interface com.sun.javadoc.AnnotationValue

Returns the value.

valueOf(String) - Static method in enum com.sun.javadoc.LanguageVersion

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.sun.javadoc.LanguageVersion

Returns an array containing the constants of this enum type, in the order they are declared.

W

WildcardType - Interface in com.sun.javadoc

Represents a wildcard type argument.