- allClasses(boolean) - Method in interface com.sun.javadoc.PackageDoc
-
- allClasses() - Method in interface com.sun.javadoc.PackageDoc
-
Get all
included
classes and interfaces in the package.
- AnnotatedType - Interface in com.sun.javadoc
-
Represents an annotated type.
- 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.AnnotatedType
-
- 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.
- annotations() - Method in interface com.sun.javadoc.TypeVariable
-
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.
- asAnnotatedType() - Method in interface com.sun.javadoc.Type
-
Returns this type as a AnnotatedType
if it represents
an annotated type.
- 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.
- 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
-
- 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.
- 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.
- importedClasses() - Method in interface com.sun.javadoc.ClassDoc
-
- importedPackages() - Method in interface com.sun.javadoc.ClassDoc
-
- 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?
- isDefault() - Method in interface com.sun.javadoc.MethodDoc
-
Return true if this method is default
- 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
-
- 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
- isSynthesized() - Method in interface com.sun.javadoc.AnnotationDesc
-
Check for the synthesized bit on the annotation.
- 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
- 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.
- 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.
- 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, the 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.