Index


Overview \| Package \| Class \| Tree \| Deprecated \| Index \| Help
PREV \| NEXT	FRAMES \| NO FRAMES

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

A

allClasses() - Method in interface com.sun.javadoc.PackageDoc: Get all classes (including Exceptions and Errors) and interfaces.
asClassDoc() - Method in interface com.sun.javadoc.Type: Return this type as a class.

C

ClassDoc - interface com.sun.javadoc.ClassDoc.: Represents a java class and provides access to information about the class, the class' comment and tags, and the members of the class.
classes() - Method in interface com.sun.javadoc.RootDoc: classes and interfaces to be documented.
classNamed(String) - Method in interface com.sun.javadoc.RootDoc: Return a ClassDoc for the specified class/interface name
com.sun.javadoc - package com.sun.javadoc: The javadoc API is used to customize the output of javadoc.
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 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.
ConstructorDoc - interface com.sun.javadoc.ConstructorDoc.: Represents a constructor of a java class.
constructors() - Method in interface com.sun.javadoc.ClassDoc: Return constructors in class.
containingClass() - Method in interface com.sun.javadoc.ProgramElementDoc: Get the containing class of this program element.
containingPackage() - Method in interface com.sun.javadoc.ClassDoc: Return the package that this class is contained in.
containingPackage() - Method in interface com.sun.javadoc.MemberDoc: Return the package that this member is contained in.

D

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 com.sun.javadoc.Doc.: abstract base class of all Doc classes.
DocErrorReporter - interface com.sun.javadoc.DocErrorReporter.: This interface provides error, warning and notice printing.
Doclet - class com.sun.javadoc.Doclet.: This class documents the entry-point methods in a Doclet.

E

errors() - Method in interface com.sun.javadoc.PackageDoc: Get Error classes in this package.
exceptionComment() - Method in interface com.sun.javadoc.ThrowsTag: Return the exception comment.
exceptionName() - Method in interface com.sun.javadoc.ThrowsTag: Return the exception name.
exceptions() - Method in interface com.sun.javadoc.PackageDoc: Get Exception classes in this package.
exception() - Method in interface com.sun.javadoc.ThrowsTag: Return the exception as a ClassDoc.
ExecutableMemberDoc - interface com.sun.javadoc.ExecutableMemberDoc.: Represents a method or constructor of a java class.

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.
fields() - Method in interface com.sun.javadoc.ClassDoc: Return fields in class.
fieldTypeDoc() - Method in interface com.sun.javadoc.SerialFieldTag: Return the ClassDoc for field type.
fieldType() - Method in interface com.sun.javadoc.SerialFieldTag: Return the field type string.
findClass(String) - Method in interface com.sun.javadoc.ClassDoc: Find a class within the context of this class.
findClass(String) - Method in interface com.sun.javadoc.PackageDoc: Lookup for a class within this package.
firstSentenceTags() - Method in interface com.sun.javadoc.Doc
flatSignature() - Method in interface com.sun.javadoc.ExecutableMemberDoc: get flat signature. all types are not qualified. return a String, which is the flat signiture of this member.

G

getRawCommentText() - Method in interface com.sun.javadoc.Doc: Return the full unprocessed text of the comment.

I

implementedInterfaces() - Method in interface com.sun.javadoc.ClassDoc: Deprecated. Use ClassDoc.interfaces() - this method will go away by FCS.
importedClasses() - Method in interface com.sun.javadoc.ClassDoc: Get the list of classes 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
inlineTags() - Method in interface com.sun.javadoc.Tag: For documentation comment with embedded @link tags, return the array of Tags consisting of SeeTag(s) and text containing Tag(s).
innerClasses() - Method in interface com.sun.javadoc.ClassDoc: Return inner classes within this class.
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 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.
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 a error class?
isException() - Method in interface com.sun.javadoc.Doc: Is this Doc item a exception class?
isExternalizable() - Method in interface com.sun.javadoc.ClassDoc: Return true if this class implements java.io.
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 is include in the active set.
isInterface() - Method in interface com.sun.javadoc.Doc: Is this Doc item a interface?
isMethod() - Method in interface com.sun.javadoc.Doc: Is this Doc item a simple method (i.e. not a constructor)?
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 a ordinary class (i.e. not an interface, exception, or error)?
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 java.io.
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 field 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
Return the label of the see tag.



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 methods in class.
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 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 here. 
 
options() - 
Method in  interface com.sun.javadoc.RootDoc
Command line options. 

 
ordinaryClasses() - 
Method in  interface com.sun.javadoc.PackageDoc
Get ordinary classes (excluding Exceptions and Errors) 
 in this package.
overridenClass() - 
Method in  interface com.sun.javadoc.MethodDoc
Return the class that overrides this method.



P

PackageDoc - interface com.sun.javadoc.PackageDoc.
Represents a java package.  
PackageDoc(String) - 
Method in  interface com.sun.javadoc.RootDoc
Return a PackageDoc for the specified class/interface name
Parameter - interface com.sun.javadoc.Parameter.
Parameter information.
 
parameterComment() - 
Method in  interface com.sun.javadoc.ParamTag
Return the parameter comment.
parameterName() - 
Method in  interface com.sun.javadoc.ParamTag
Return the parameter name.
parameters() - 
Method in  interface com.sun.javadoc.ExecutableMemberDoc
Get argument information.
ParamTag - interface com.sun.javadoc.ParamTag.
Represents an @param documentation tag.
 
paramTags() - 
Method in  interface com.sun.javadoc.ExecutableMemberDoc
Return the param tags in this method.
printError(String) - 
Method in  interface com.sun.javadoc.DocErrorReporter
Print error message, increment error count.
printNotice(String) - 
Method in  interface com.sun.javadoc.DocErrorReporter
Print a message.
printWarning(String) - 
Method in  interface com.sun.javadoc.DocErrorReporter
Print warning message, increment warning count.
ProgramElementDoc - interface com.sun.javadoc.ProgramElementDoc.
Represents a java program element: class, interface, field, 
 constructor, or method.
 


Q

qualifiedName() - 
Method in  interface com.sun.javadoc.ClassDoc
Return the qualified class name as a String.
 
qualifiedName() - 
Method in  interface com.sun.javadoc.ConstructorDoc
Get the name.
qualifiedName() - 
Method in  interface com.sun.javadoc.MemberDoc
Get the name.
qualifiedTypeName() - 
Method in  interface com.sun.javadoc.Type
Return qualified name of type excluding any dimension information.




R

referencedClassName() - 
Method in  interface com.sun.javadoc.SeeTag
get the class name part of @see, For instance, 
 if the comment is @see String#startsWith(java.lang.
referencedClass() - 
Method in  interface com.sun.javadoc.SeeTag
get the class referenced by the class name part of @see, For instance, 
 if the comment is @see String#startsWith(java.lang.
referencedMemberName() - 
Method in  interface com.sun.javadoc.SeeTag
get the name of the member referenced by the prototype part of @see,
 For instance, 
 if the comment is @see String#startsWith(java.lang.
referencedMember() - 
Method in  interface com.sun.javadoc.SeeTag
get the member referenced by the prototype part of @see,
 For instance, 
 if the comment is @see String#startsWith(java.lang.
returnType() - 
Method in  interface com.sun.javadoc.MethodDoc
Get return type.
RootDoc - interface com.sun.javadoc.RootDoc.
This class holds the information from one run of javadoc.
 


S

SeeTag - interface com.sun.javadoc.SeeTag.
Represents a see also documentation tag.
 
seeTags() - 
Method in  interface com.sun.javadoc.Doc
Return the see also tags in this Doc item.
SerialFieldTag - interface com.sun.javadoc.SerialFieldTag.
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 class.
serializationMethods() - 
Method in  interface com.sun.javadoc.ClassDoc
Return the serialization methods for this class.
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
classes and interfaces specified on the command line.
specifiedPackages() - 
Method in  interface com.sun.javadoc.RootDoc
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 documentation tag, e.g. 
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.
ThrowsTag - interface com.sun.javadoc.ThrowsTag.
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.Parameter
Returns a string representation of the class.
 
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 - interface com.sun.javadoc.Type.
Represents a java type. 
type() - 
Method in  interface com.sun.javadoc.FieldDoc
Get type of this field.
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.
 
type() - 
Method in  interface com.sun.javadoc.Parameter
Get the type of this parameter.



V

validOptions(String[][], DocErrorReporter) - 
Static method in  class com.sun.javadoc.Doclet
Check that options have the correct arguments here. 
 


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








Overview | Package | Class | Tree | Deprecated | Index | Help






PREV | NEXT


FRAMES
 | NO FRAMES