vdoclet.docinfo
Class ClassInfo

java.lang.Object
  |
  +--vdoclet.docinfo.BaseInfo
        |
        +--vdoclet.docinfo.BaseElementInfo
              |
              +--vdoclet.docinfo.ClassInfo

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

RegisteredClassInfo

public class ClassInfo

extends BaseElementInfo

Info about a Class.

Constructor Summary

ClassInfo(String name)
Create a new ClassInfo with the specified name

Method Summary

void	addField(FieldInfo field)
void	addFields(Collection fields)
void	addInterface(String iface)
void	addInterfaces(Collection interfaces)
void	addMethod(MethodInfo method)
void	addMethods(Collection methods)
DocInfo	getContainingDocInfo() Get the containing DocInfo
FieldInfo	getField(int index)
List	getFields()
Collection	getInterfaces()
MethodInfo	getMethod(int index)
MethodInfo	getMethod(String name, List types)
List	getMethods()
String	getName() Get the fully-qualified class-name
String	getPackage() Get the name of the enclosing package
String	getShortName() Get the un-qualified class-name
String	getSuperClass()
boolean	hasInterface(String name) Return true if this class implements the interface, either directly or thru it's super-class.
ClassInfo	resolveSuperClass()
void	setContainingDocInfo(DocInfo docInfo) Set the containing DocInfo
void	setSuperClass(String superClassName)

Methods inherited from class vdoclet.docinfo.BaseElementInfo

getModifiers, isAbstract, isFinal, isPrivate, isProtected, isPublic, isStatic, setAbstract, setFinal, setPrivate, setProtected, setPublic, setStatic

Methods inherited from class vdoclet.docinfo.BaseInfo

addTag, addTag, addTags, clone, getComment, getTag, getTags, getTags, getTagValue, getTagValue, setComment, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassInfo

public ClassInfo(String name)

Create a new ClassInfo with the specified name

Parameters:

name - fully-qualified class-name

Method Detail

setContainingDocInfo

public void setContainingDocInfo(DocInfo docInfo)

Set the containing DocInfo

getContainingDocInfo

public DocInfo getContainingDocInfo()

Get the containing DocInfo

getName

public String getName()

Get the fully-qualified class-name

Overrides:

getName in class BaseInfo

getPackage

public String getPackage()

Get the name of the enclosing package

getShortName

public String getShortName()

Get the un-qualified class-name

addField

public void addField(FieldInfo field)

addFields

public void addFields(Collection fields)

getFields

public List getFields()

getField

public FieldInfo getField(int index)

addMethod

public void addMethod(MethodInfo method)

addMethods

public void addMethods(Collection methods)

getMethods

public List getMethods()

getMethod

public MethodInfo getMethod(int index)

getMethod

public MethodInfo getMethod(String name,
                            List types)

setSuperClass

public void setSuperClass(String superClassName)

getSuperClass

public String getSuperClass()

resolveSuperClass

public ClassInfo resolveSuperClass()

addInterface

public void addInterface(String iface)

addInterfaces

public void addInterfaces(Collection interfaces)

getInterfaces

public Collection getInterfaces()

hasInterface

public boolean hasInterface(String name)

Return true if this class implements the interface, either directly or thru it's super-class.