A C D E F G H I K L M N O P Q R S T V

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.

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

Return this type as a class doc if this type is a class or interface.

C

ClassDoc - interface com.sun.javadoc.ClassDoc.

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.

ConstructorDoc - interface com.sun.javadoc.ConstructorDoc.

Represents a constructor of a java class.

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

Return a ClassDoc for the specified class or interface name.

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

Return the included classes and interfaces in all packages.

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.

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.

D

Doc - interface com.sun.javadoc.Doc.

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

DocErrorReporter - interface com.sun.javadoc.DocErrorReporter.

This interface provides error, warning and notice printing.

Doclet - class com.sun.javadoc.Doclet.

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

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

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.

E

ExecutableMemberDoc - interface com.sun.javadoc.ExecutableMemberDoc.

Represents a method or constructor of a java class.

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 which 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.

F

FieldDoc - interface com.sun.javadoc.FieldDoc.

Represents a field in a java class.

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

Return the serialziable field name.

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.

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

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

Get the list of classes and interfaces declared as imported.

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

Get the list of packages declared as imported.

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.

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

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

Is this Doc item a class (not an interface)? This includes ordinary classes, errors and exceptions.

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

Is this Doc item a constructor?

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?

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?

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

Is this Doc item a method (i.e.

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? (i.e.

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

Return true if this program element is package private.

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

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.

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

The line in the source file.

M

MemberDoc - interface com.sun.javadoc.MemberDoc.

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

MethodDoc - interface com.sun.javadoc.MethodDoc.

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.

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

Get the modifier specifier integer.

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

Get modifiers string.

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 and interfaces) 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.

P

PackageDoc - interface com.sun.javadoc.PackageDoc.

Represents a java package.

ParamTag - interface com.sun.javadoc.ParamTag.

Represents an @param documentation tag.

Parameter - interface com.sun.javadoc.Parameter.

Parameter information.

ProgramElementDoc - interface com.sun.javadoc.ProgramElementDoc.

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

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

Return a PackageDoc for the specified package name.

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

Return the param tags in this method.

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

Return the parameter comment associated with this ParamTag.

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

Return the name of the parameter associated with this ParamTag.

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

Get argument information.

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.

Q

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

Get the name.

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

RootDoc - interface com.sun.javadoc.RootDoc.

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

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.

S

SeeTag - interface com.sun.javadoc.SeeTag.

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

SerialFieldTag - interface com.sun.javadoc.SerialFieldTag.

Documents a Serializable field defined by an ObjectStreamField.

SourcePosition - interface com.sun.javadoc.SourcePosition.

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

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

Return the see also tags in this Doc item.

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.

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.

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

Return the superclass of this class.

T

Tag - interface com.sun.javadoc.Tag.

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

ThrowsTag - interface com.sun.javadoc.ThrowsTag.

Represents a @throws or @exception documentation tag.

Type - interface com.sun.javadoc.Type.

Represents a java type.

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.

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

Return the throws tags in this method.

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

Returns a string representation of the class.

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

Returns 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.

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.

V

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

Check that options have the correct arguments.

A C D E F G H I K L M N O P Q R S T V