org.sandev.generator
Class SandClassDoc

java.lang.Object
  org.sandev.generator.SandClassDoc

All Implemented Interfaces:

com.sun.javadoc.ClassDoc, java.lang.Comparable, com.sun.javadoc.Doc, com.sun.javadoc.ProgramElementDoc, com.sun.javadoc.Type

public class SandClassDoc

extends java.lang.Object

implements com.sun.javadoc.ClassDoc

Bare-minimum ClassDoc to support doclets. Most functionality is not implemented, or has minimal implementation.

Field Summary

protected java.lang.String	comments
protected com.sun.javadoc.FieldDoc[]	fields
protected com.sun.javadoc.Type	type

Constructor Summary

SandClassDoc(com.sun.javadoc.Type type, java.lang.String comments, com.sun.javadoc.FieldDoc[] fields)

Method Summary

com.sun.javadoc.ClassDoc	asClassDoc() Not implemented; returns null.
java.lang.String	commentText()
int	compareTo(java.lang.Object obj) Not implemented; always returns 0.
com.sun.javadoc.ConstructorDoc[]	constructors() Not implemented; returns null.
com.sun.javadoc.ConstructorDoc[]	constructors(boolean filter) Not implemented; returns null.
com.sun.javadoc.ClassDoc	containingClass() All classes are assumed to be outer classes so return null
com.sun.javadoc.PackageDoc	containingPackage() Not implemented; returns null
boolean	definesSerializableFields() Not implemented; returns false.
java.lang.String	dimension()
com.sun.javadoc.FieldDoc[]	fields()
com.sun.javadoc.FieldDoc[]	fields(boolean filter) Same as regular fields method with no params
com.sun.javadoc.ClassDoc	findClass(java.lang.String className) Not implemented; returns null.
com.sun.javadoc.Tag[]	firstSentenceTags() Not implemented; returns null.
java.lang.String	getRawCommentText() Equivalent to commentText().
com.sun.javadoc.ClassDoc[]	importedClasses() Not implemented; returns null.
com.sun.javadoc.PackageDoc[]	importedPackages() Not implemented; returns null.
com.sun.javadoc.Tag[]	inlineTags() Not implemented; returns null.
com.sun.javadoc.ClassDoc[]	innerClasses() Not implemented; returns null.
com.sun.javadoc.ClassDoc[]	innerClasses(boolean filter) Not implemented; returns null.
com.sun.javadoc.ClassDoc[]	interfaces() Not implemented; returns null.
boolean	isAbstract() Not implemented; returns false.
boolean	isClass()
boolean	isConstructor()
boolean	isError()
boolean	isException()
boolean	isExternalizable() Not implemented; returns false.
boolean	isField()
boolean	isFinal() Constants aren't supported, so return false
boolean	isIncluded()
boolean	isInterface()
boolean	isMethod()
boolean	isOrdinaryClass() Returns true
boolean	isPackagePrivate() Private packages aren't supported, so return false
boolean	isPrivate() All classes are assumed to be public, so return false
boolean	isProtected() All classes are assumed to be public, so return false
boolean	isPublic() All classes are assumed to be public, so return true
boolean	isSerializable() Not implemented; returns false.
boolean	isStatic() Static classes aren't supported, so return false
com.sun.javadoc.MethodDoc[]	methods() Not implemented; returns null.
com.sun.javadoc.MethodDoc[]	methods(boolean filter) Not implemented; returns null.
java.lang.String	modifiers() Returns modifiers for the class; all classes are assumed to be public
int	modifierSpecifier() Stupid Sun
java.lang.String	name() Implemented as a passthrough to typeName()
com.sun.javadoc.SourcePosition	position() Not applicable; returns null.
java.lang.String	qualifiedName() Gets the fully qualified name of the class
java.lang.String	qualifiedTypeName()
com.sun.javadoc.SeeTag[]	seeTags() No @see tags, so returns null.
com.sun.javadoc.FieldDoc[]	serializableFields() Not implemented; returns null.
com.sun.javadoc.MethodDoc[]	serializationMethods() Not implemented; returns null.
void	setRawCommentText(java.lang.String rawDocumentation)
boolean	subclassOf(com.sun.javadoc.ClassDoc cd) Not implemented; returns false.
com.sun.javadoc.ClassDoc	superclass() Not implemented; returns null.
com.sun.javadoc.Tag[]	tags() Not implemented; returns empty Tag[]
com.sun.javadoc.Tag[]	tags(java.lang.String tagname) Implemented as passthrough to tags().
java.lang.String	toString()
java.lang.String	typeName()

Methods inherited from class java.lang.Object

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

Field Detail

type

protected com.sun.javadoc.Type type

comments

protected java.lang.String comments

fields

protected com.sun.javadoc.FieldDoc[] fields

Constructor Detail

SandClassDoc

public SandClassDoc(com.sun.javadoc.Type type,
                    java.lang.String comments,
                    com.sun.javadoc.FieldDoc[] fields)

Method Detail

constructors

public com.sun.javadoc.ConstructorDoc[] constructors()

Not implemented; returns null.

Specified by:

constructors in interface com.sun.javadoc.ClassDoc

constructors

public com.sun.javadoc.ConstructorDoc[] constructors(boolean filter)

Not implemented; returns null.

Specified by:

constructors in interface com.sun.javadoc.ClassDoc

definesSerializableFields

public boolean definesSerializableFields()

Not implemented; returns false.

Specified by:

definesSerializableFields in interface com.sun.javadoc.ClassDoc

fields

public com.sun.javadoc.FieldDoc[] fields()

Specified by:

fields in interface com.sun.javadoc.ClassDoc

fields

public com.sun.javadoc.FieldDoc[] fields(boolean filter)

Same as regular fields method with no params

Specified by:

fields in interface com.sun.javadoc.ClassDoc

findClass

public com.sun.javadoc.ClassDoc findClass(java.lang.String className)

Not implemented; returns null.

Specified by:

findClass in interface com.sun.javadoc.ClassDoc

importedClasses

public com.sun.javadoc.ClassDoc[] importedClasses()

Not implemented; returns null.

Specified by:

importedClasses in interface com.sun.javadoc.ClassDoc

importedPackages

public com.sun.javadoc.PackageDoc[] importedPackages()

Not implemented; returns null.

Specified by:

importedPackages in interface com.sun.javadoc.ClassDoc

innerClasses

public com.sun.javadoc.ClassDoc[] innerClasses()

Not implemented; returns null.

Specified by:

innerClasses in interface com.sun.javadoc.ClassDoc

innerClasses

public com.sun.javadoc.ClassDoc[] innerClasses(boolean filter)

Not implemented; returns null.

Specified by:

innerClasses in interface com.sun.javadoc.ClassDoc

interfaces

public com.sun.javadoc.ClassDoc[] interfaces()

Not implemented; returns null.

Specified by:

interfaces in interface com.sun.javadoc.ClassDoc

isAbstract

public boolean isAbstract()

Not implemented; returns false.

Specified by:

isAbstract in interface com.sun.javadoc.ClassDoc

isExternalizable

public boolean isExternalizable()

Not implemented; returns false.

Specified by:

isExternalizable in interface com.sun.javadoc.ClassDoc

isSerializable

public boolean isSerializable()

Not implemented; returns false.

Specified by:

isSerializable in interface com.sun.javadoc.ClassDoc

methods

public com.sun.javadoc.MethodDoc[] methods()

Not implemented; returns null.

Specified by:

methods in interface com.sun.javadoc.ClassDoc

methods

public com.sun.javadoc.MethodDoc[] methods(boolean filter)

Not implemented; returns null.

Specified by:

methods in interface com.sun.javadoc.ClassDoc

serializableFields

public com.sun.javadoc.FieldDoc[] serializableFields()

Not implemented; returns null.

Specified by:

serializableFields in interface com.sun.javadoc.ClassDoc

serializationMethods

public com.sun.javadoc.MethodDoc[] serializationMethods()

Not implemented; returns null.

Specified by:

serializationMethods in interface com.sun.javadoc.ClassDoc

subclassOf

public boolean subclassOf(com.sun.javadoc.ClassDoc cd)

Not implemented; returns false.

Specified by:

subclassOf in interface com.sun.javadoc.ClassDoc

superclass

public com.sun.javadoc.ClassDoc superclass()

Not implemented; returns null.

Specified by:

superclass in interface com.sun.javadoc.ClassDoc

containingClass

public com.sun.javadoc.ClassDoc containingClass()

All classes are assumed to be outer classes so return null

Specified by:

containingClass in interface com.sun.javadoc.ProgramElementDoc

containingPackage

public com.sun.javadoc.PackageDoc containingPackage()

Not implemented; returns null

Specified by:

containingPackage in interface com.sun.javadoc.ProgramElementDoc

isFinal

public boolean isFinal()

Constants aren't supported, so return false

Specified by:

isFinal in interface com.sun.javadoc.ProgramElementDoc

isPackagePrivate

public boolean isPackagePrivate()

Private packages aren't supported, so return false

Specified by:

isPackagePrivate in interface com.sun.javadoc.ProgramElementDoc

isPrivate

public boolean isPrivate()

All classes are assumed to be public, so return false

Specified by:

isPrivate in interface com.sun.javadoc.ProgramElementDoc

isProtected

public boolean isProtected()

All classes are assumed to be public, so return false

Specified by:

isProtected in interface com.sun.javadoc.ProgramElementDoc

isPublic

public boolean isPublic()

All classes are assumed to be public, so return true

Specified by:

isPublic in interface com.sun.javadoc.ProgramElementDoc

isStatic

public boolean isStatic()

Static classes aren't supported, so return false

Specified by:

isStatic in interface com.sun.javadoc.ProgramElementDoc

modifiers

public java.lang.String modifiers()

Returns modifiers for the class; all classes are assumed to be public

Specified by:

modifiers in interface com.sun.javadoc.ProgramElementDoc

modifierSpecifier

public int modifierSpecifier()

Stupid Sun

Specified by:

modifierSpecifier in interface com.sun.javadoc.ProgramElementDoc

qualifiedName

public java.lang.String qualifiedName()

Gets the fully qualified name of the class

Specified by:

qualifiedName in interface com.sun.javadoc.ProgramElementDoc

commentText

public java.lang.String commentText()

Specified by:

commentText in interface com.sun.javadoc.Doc

compareTo

public int compareTo(java.lang.Object obj)

Not implemented; always returns 0.

Specified by:

compareTo in interface com.sun.javadoc.Doc

firstSentenceTags

public com.sun.javadoc.Tag[] firstSentenceTags()

Not implemented; returns null.

Specified by:

firstSentenceTags in interface com.sun.javadoc.Doc

getRawCommentText

public java.lang.String getRawCommentText()

Equivalent to commentText(). I hope nobody minds.

Specified by:

getRawCommentText in interface com.sun.javadoc.Doc

inlineTags

public com.sun.javadoc.Tag[] inlineTags()

Not implemented; returns null.

Specified by:

inlineTags in interface com.sun.javadoc.Doc

isClass

public boolean isClass()

Specified by:

isClass in interface com.sun.javadoc.Doc

isConstructor

public boolean isConstructor()

Specified by:

isConstructor in interface com.sun.javadoc.Doc

isError

public boolean isError()

Specified by:

isError in interface com.sun.javadoc.Doc

isException

public boolean isException()

Specified by:

isException in interface com.sun.javadoc.Doc

isField

public boolean isField()

Specified by:

isField in interface com.sun.javadoc.Doc

isIncluded

public boolean isIncluded()

Specified by:

isIncluded in interface com.sun.javadoc.Doc

isInterface

public boolean isInterface()

Specified by:

isInterface in interface com.sun.javadoc.Doc

isMethod

public boolean isMethod()

Specified by:

isMethod in interface com.sun.javadoc.Doc

isOrdinaryClass

public boolean isOrdinaryClass()

Returns true

Specified by:

isOrdinaryClass in interface com.sun.javadoc.Doc

name

public java.lang.String name()

Implemented as a passthrough to typeName()

Specified by:

name in interface com.sun.javadoc.Doc

position

public com.sun.javadoc.SourcePosition position()

Not applicable; returns null.

Specified by:

position in interface com.sun.javadoc.Doc

seeTags

public com.sun.javadoc.SeeTag[] seeTags()

No @see tags, so returns null.

Specified by:

seeTags in interface com.sun.javadoc.Doc

setRawCommentText

public void setRawCommentText(java.lang.String rawDocumentation)

Specified by:

setRawCommentText in interface com.sun.javadoc.Doc

tags

public com.sun.javadoc.Tag[] tags()

Not implemented; returns empty Tag[]

Specified by:

tags in interface com.sun.javadoc.Doc

tags

public com.sun.javadoc.Tag[] tags(java.lang.String tagname)

Implemented as passthrough to tags().

Specified by:

tags in interface com.sun.javadoc.Doc

asClassDoc

public com.sun.javadoc.ClassDoc asClassDoc()

Not implemented; returns null.

Specified by:

asClassDoc in interface com.sun.javadoc.Type

dimension

public java.lang.String dimension()

Specified by:

dimension in interface com.sun.javadoc.Type

qualifiedTypeName

public java.lang.String qualifiedTypeName()

Specified by:

qualifiedTypeName in interface com.sun.javadoc.Type

toString

public java.lang.String toString()

Specified by:

toString in interface com.sun.javadoc.Type

typeName

public java.lang.String typeName()

Specified by:

typeName in interface com.sun.javadoc.Type