xdoclet.util.serialveruid
Class ClassDocImpl

java.lang.Object
  |
  +--xdoclet.util.serialveruid.DocImpl
        |
        +--xdoclet.util.serialveruid.ProgramElementDocImpl
              |
              +--xdoclet.util.serialveruid.ClassDocImpl
All Implemented Interfaces:
com.sun.javadoc.ClassDoc, java.lang.Comparable, com.sun.javadoc.Doc, com.sun.javadoc.ProgramElementDoc, java.io.Serializable, com.sun.javadoc.Type

public class ClassDocImpl
extends xdoclet.util.serialveruid.ProgramElementDocImpl
implements com.sun.javadoc.ClassDoc

Version:
$Revision 1.1 $
Author:
Ara Abrahamian (ara_e@email.com)
See Also:
Serialized Form

Constructor Summary
ClassDocImpl(int modifiers, java.lang.String qualifier, java.lang.String name, java.util.List fields, java.util.List methods, java.util.List constructors)
           
 
Method Summary
 com.sun.javadoc.ClassDoc asClassDoc()
           
 java.lang.String commentText()
           
 int compareTo(java.lang.Object obj)
           
 com.sun.javadoc.ConstructorDoc[] constructors()
           
 com.sun.javadoc.ClassDoc containingClass()
           
 com.sun.javadoc.PackageDoc containingPackage()
           
 boolean definesSerializableFields()
           
 java.lang.String dimension()
           
 com.sun.javadoc.FieldDoc[] fields()
           
 com.sun.javadoc.ClassDoc findClass(java.lang.String s)
           
 com.sun.javadoc.ConstructorDoc findConstructor(java.lang.String s, java.lang.String[] as)
           
 com.sun.javadoc.FieldDoc findField(java.lang.String s)
           
 com.sun.javadoc.MethodDoc findMethod(java.lang.String s, java.lang.String[] as)
           
 com.sun.javadoc.Tag[] firstSentenceTags()
           
 java.lang.String getRawCommentText()
           
 com.sun.javadoc.ClassDoc[] implementedInterfaces()
           
 com.sun.javadoc.ClassDoc[] importedClasses()
           
 com.sun.javadoc.PackageDoc[] importedPackages()
           
 com.sun.javadoc.Tag[] inlineTags()
           
 com.sun.javadoc.ClassDoc[] innerClasses()
           
 com.sun.javadoc.ClassDoc[] interfaces()
           
 boolean isAbstract()
           
 boolean isClass()
           
 boolean isConstructor()
           
 boolean isError()
           
 boolean isException()
           
 boolean isExternalizable()
           
 boolean isField()
           
 boolean isFinal()
           
 boolean isIncluded()
           
 boolean isInterface()
           
 boolean isMethod()
           
 boolean isOrdinaryClass()
           
 boolean isPackagePrivate()
           
 boolean isPrivate()
           
 boolean isProtected()
           
 boolean isPublic()
           
 boolean isSerializable()
           
 boolean isStatic()
           
 com.sun.javadoc.MethodDoc[] methods()
           
 java.lang.String modifiers()
           
 int modifierSpecifier()
           
 java.lang.String name()
           
 java.lang.String qualifiedName()
           
 java.lang.String qualifiedTypeName()
           
 com.sun.javadoc.SeeTag[] seeTags()
           
 com.sun.javadoc.FieldDoc[] serializableFields()
           
 com.sun.javadoc.MethodDoc[] serializationMethods()
           
 void setRawCommentText(java.lang.String s)
           
 boolean subclassOf(com.sun.javadoc.ClassDoc classdoc)
           
 com.sun.javadoc.ClassDoc superclass()
           
 com.sun.javadoc.Tag[] tags()
           
 com.sun.javadoc.Tag[] tags(java.lang.String s)
           
 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
 
Methods inherited from interface com.sun.javadoc.ProgramElementDoc
containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifierSpecifier
 
Methods inherited from interface com.sun.javadoc.Doc
commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isConstructor, isField, isMethod, seeTags, setRawCommentText, tags, tags
 

Constructor Detail

ClassDocImpl

public ClassDocImpl(int modifiers,
                    java.lang.String qualifier,
                    java.lang.String name,
                    java.util.List fields,
                    java.util.List methods,
                    java.util.List constructors)
Method Detail

isSerializable

public boolean isSerializable()
Specified by:
isSerializable in interface com.sun.javadoc.ClassDoc

isExternalizable

public boolean isExternalizable()
Specified by:
isExternalizable in interface com.sun.javadoc.ClassDoc

isClass

public boolean isClass()
Specified by:
isClass in interface com.sun.javadoc.Doc
Overrides:
isClass in class xdoclet.util.serialveruid.DocImpl

isOrdinaryClass

public boolean isOrdinaryClass()
Specified by:
isOrdinaryClass in interface com.sun.javadoc.Doc
Overrides:
isOrdinaryClass in class xdoclet.util.serialveruid.DocImpl

isInterface

public boolean isInterface()
Specified by:
isInterface in interface com.sun.javadoc.Doc
Overrides:
isInterface in class xdoclet.util.serialveruid.DocImpl

isException

public boolean isException()
Specified by:
isException in interface com.sun.javadoc.Doc
Overrides:
isException in class xdoclet.util.serialveruid.DocImpl

isError

public boolean isError()
Specified by:
isError in interface com.sun.javadoc.Doc
Overrides:
isError in class xdoclet.util.serialveruid.DocImpl

isAbstract

public boolean isAbstract()
Specified by:
isAbstract in interface com.sun.javadoc.ClassDoc

isIncluded

public boolean isIncluded()
Specified by:
isIncluded in interface com.sun.javadoc.Doc

serializationMethods

public com.sun.javadoc.MethodDoc[] serializationMethods()
Specified by:
serializationMethods in interface com.sun.javadoc.ClassDoc

serializableFields

public com.sun.javadoc.FieldDoc[] serializableFields()
Specified by:
serializableFields in interface com.sun.javadoc.ClassDoc

definesSerializableFields

public boolean definesSerializableFields()
Specified by:
definesSerializableFields in interface com.sun.javadoc.ClassDoc

name

public java.lang.String name()
Specified by:
name in interface com.sun.javadoc.Doc
Overrides:
name in class xdoclet.util.serialveruid.DocImpl

typeName

public java.lang.String typeName()
Specified by:
typeName in interface com.sun.javadoc.Type

qualifiedName

public java.lang.String qualifiedName()
Specified by:
qualifiedName in interface com.sun.javadoc.ProgramElementDoc
Overrides:
qualifiedName in class xdoclet.util.serialveruid.ProgramElementDocImpl

qualifiedTypeName

public java.lang.String qualifiedTypeName()
Specified by:
qualifiedTypeName in interface com.sun.javadoc.Type

dimension

public java.lang.String dimension()
Specified by:
dimension in interface com.sun.javadoc.Type

asClassDoc

public com.sun.javadoc.ClassDoc asClassDoc()
Specified by:
asClassDoc in interface com.sun.javadoc.Type

toString

public java.lang.String toString()
Specified by:
toString in interface com.sun.javadoc.Type
Overrides:
toString in class xdoclet.util.serialveruid.DocImpl

importedClasses

public com.sun.javadoc.ClassDoc[] importedClasses()
Specified by:
importedClasses in interface com.sun.javadoc.ClassDoc

importedPackages

public com.sun.javadoc.PackageDoc[] importedPackages()
Specified by:
importedPackages in interface com.sun.javadoc.ClassDoc

findConstructor

public com.sun.javadoc.ConstructorDoc findConstructor(java.lang.String s,
                                                      java.lang.String[] as)

findField

public com.sun.javadoc.FieldDoc findField(java.lang.String s)

findMethod

public com.sun.javadoc.MethodDoc findMethod(java.lang.String s,
                                            java.lang.String[] as)

findClass

public com.sun.javadoc.ClassDoc findClass(java.lang.String s)
Specified by:
findClass in interface com.sun.javadoc.ClassDoc

modifiers

public java.lang.String modifiers()
Specified by:
modifiers in interface com.sun.javadoc.ProgramElementDoc
Overrides:
modifiers in class xdoclet.util.serialveruid.ProgramElementDocImpl

superclass

public com.sun.javadoc.ClassDoc superclass()
Specified by:
superclass in interface com.sun.javadoc.ClassDoc

subclassOf

public boolean subclassOf(com.sun.javadoc.ClassDoc classdoc)
Specified by:
subclassOf in interface com.sun.javadoc.ClassDoc

interfaces

public com.sun.javadoc.ClassDoc[] interfaces()
Specified by:
interfaces in interface com.sun.javadoc.ClassDoc

implementedInterfaces

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

fields

public com.sun.javadoc.FieldDoc[] fields()
Specified by:
fields in interface com.sun.javadoc.ClassDoc

methods

public com.sun.javadoc.MethodDoc[] methods()
Specified by:
methods in interface com.sun.javadoc.ClassDoc

constructors

public com.sun.javadoc.ConstructorDoc[] constructors()
Specified by:
constructors in interface com.sun.javadoc.ClassDoc

innerClasses

public com.sun.javadoc.ClassDoc[] innerClasses()
Specified by:
innerClasses in interface com.sun.javadoc.ClassDoc

isPublic

public boolean isPublic()
Specified by:
isPublic in interface com.sun.javadoc.ProgramElementDoc

isProtected

public boolean isProtected()
Specified by:
isProtected in interface com.sun.javadoc.ProgramElementDoc

isPrivate

public boolean isPrivate()
Specified by:
isPrivate in interface com.sun.javadoc.ProgramElementDoc

isPackagePrivate

public boolean isPackagePrivate()
Specified by:
isPackagePrivate in interface com.sun.javadoc.ProgramElementDoc

isStatic

public boolean isStatic()
Specified by:
isStatic in interface com.sun.javadoc.ProgramElementDoc

isFinal

public boolean isFinal()
Specified by:
isFinal in interface com.sun.javadoc.ProgramElementDoc

containingClass

public com.sun.javadoc.ClassDoc containingClass()
Specified by:
containingClass in interface com.sun.javadoc.ProgramElementDoc

modifierSpecifier

public int modifierSpecifier()
Specified by:
modifierSpecifier in interface com.sun.javadoc.ProgramElementDoc

containingPackage

public com.sun.javadoc.PackageDoc containingPackage()
Specified by:
containingPackage in interface com.sun.javadoc.ProgramElementDoc

setRawCommentText

public void setRawCommentText(java.lang.String s)
Specified by:
setRawCommentText in interface com.sun.javadoc.Doc

getRawCommentText

public java.lang.String getRawCommentText()
Specified by:
getRawCommentText in interface com.sun.javadoc.Doc

isField

public boolean isField()
Specified by:
isField in interface com.sun.javadoc.Doc

isMethod

public boolean isMethod()
Specified by:
isMethod in interface com.sun.javadoc.Doc

isConstructor

public boolean isConstructor()
Specified by:
isConstructor in interface com.sun.javadoc.Doc

commentText

public java.lang.String commentText()
Specified by:
commentText in interface com.sun.javadoc.Doc

tags

public com.sun.javadoc.Tag[] tags()
Specified by:
tags in interface com.sun.javadoc.Doc

tags

public com.sun.javadoc.Tag[] tags(java.lang.String s)
Specified by:
tags in interface com.sun.javadoc.Doc

seeTags

public com.sun.javadoc.SeeTag[] seeTags()
Specified by:
seeTags in interface com.sun.javadoc.Doc

inlineTags

public com.sun.javadoc.Tag[] inlineTags()
Specified by:
inlineTags in interface com.sun.javadoc.Doc

firstSentenceTags

public com.sun.javadoc.Tag[] firstSentenceTags()
Specified by:
firstSentenceTags in interface com.sun.javadoc.Doc

compareTo

public int compareTo(java.lang.Object obj)
Specified by:
compareTo in interface com.sun.javadoc.Doc