com.thoughtworks.qdox.model

Class JavaClass

Implemented Interfaces:
Comparable, JavaClassParent, Serializable

public class JavaClass
extends AbstractInheritableJavaEntity
implements JavaClassParent

Field Summary

Fields inherited from class com.thoughtworks.qdox.model.AbstractJavaEntity

modifiers, name

Constructor Summary

JavaClass()
JavaClass(String name)

Method Summary

void
addClass(JavaClass cls)
void
addField(JavaField javaField)
void
addMethod(JavaMethod meth)
Type
asType()
int
compareTo(Object o)
BeanProperty[]
getBeanProperties()
Gets bean properties without looking in superclasses or interfaces.
BeanProperty[]
getBeanProperties(boolean superclasses)
BeanProperty
getBeanProperty(String propertyName)
Gets bean property without looking in superclasses or interfaces.
BeanProperty
getBeanProperty(String propertyName, boolean superclasses)
ClassLibrary
getClassLibrary()
String
getClassNamePrefix()
JavaClass[]
getClasses()
Deprecated. Use getNestedClasses() instead.
JavaClass[]
getDerivedClasses()
Gets the known derived classes.
JavaField
getFieldByName(String name)
JavaField[]
getFields()
String
getFullyQualifiedName()
JavaClass[]
getImplementedInterfaces()
Type[]
getImplements()
JavaClass
getInnerClassByName(String name)
Deprecated. old name for getNestedClassByName(String)
JavaClass[]
getInnerClasses()
Deprecated. old name for getNestedClasses()
JavaMethod
getMethodBySignature(String name, Type[] parameterTypes)
JavaMethod
getMethodBySignature(String name, Type[] parameterTypes, boolean superclasses)
JavaMethod[]
getMethods()
JavaMethod[]
getMethods(boolean superclasses)
JavaMethod[]
getMethodsBySignature(String name, Type[] parameterTypes, boolean superclasses)
JavaClass
getNestedClassByName(String name)
JavaClass[]
getNestedClasses()
String
getPackage()
JavaSource
getParentSource()
Type
getSuperClass()
JavaClass
getSuperJavaClass()
Shorthand for getSuperClass().getJavaClass() with null checking.
DocletTag[]
getTagsByName(String name, boolean superclasses)
boolean
isA(String fullClassName)
boolean
isA(JavaClass javaClass)
boolean
isEnum()
is enum? (otherwise class or interface)
boolean
isInner()
boolean
isInterface()
is interface? (otherwise enum or class)
String
resolveType(String typeName)
void
setAnnotation(boolean isAnnotation)
void
setEnum(boolean isEnum)
void
setImplementz(Type[] implementz)
void
setInterface(boolean interfce)
void
setJavaClassCache(JavaClassCache javaClassCache)
void
setSuperClass(Type type)
protected void
writeBody(IndentBuffer result)

Methods inherited from class com.thoughtworks.qdox.model.AbstractInheritableJavaEntity

getTagByName, getTagsByName

Methods inherited from class com.thoughtworks.qdox.model.AbstractJavaEntity

getAnnotations, getComment, getLineNumber, getModifiers, getName, getNamedParameter, getParent, getSource, getTagByName, getTags, getTagsByName, isAbstract, isFinal, isNative, isPrivate, isProtected, isPublic, isStatic, isStrictfp, isSynchronized, isTransient, isVolatile, setAnnotations, setComment, setLineNumber, setModifiers, setName, setParent, setTags, toString, write, writeAccessibilityModifier, writeAllModifiers, writeBody, writeNonAccessibilityModifiers

Constructor Details

JavaClass

public JavaClass()

JavaClass

public JavaClass(String name)

Method Details

addClass

public void addClass(JavaClass cls)
Specified by:
addClass in interface JavaClassParent

addField

public void addField(JavaField javaField)

addMethod

public void addMethod(JavaMethod meth)

asType

public Type asType()

compareTo

public int compareTo(Object o)

getBeanProperties

public BeanProperty[] getBeanProperties()
Gets bean properties without looking in superclasses or interfaces.
Since:
1.3

getBeanProperties

public BeanProperty[] getBeanProperties(boolean superclasses)
Since:
1.3

getBeanProperty

public BeanProperty getBeanProperty(String propertyName)
Gets bean property without looking in superclasses or interfaces.
Since:
1.3

getBeanProperty

public BeanProperty getBeanProperty(String propertyName,
                                    boolean superclasses)
Since:
1.3

getClassLibrary

public ClassLibrary getClassLibrary()
Specified by:
getClassLibrary in interface JavaClassParent

getClassNamePrefix

public String getClassNamePrefix()
Specified by:
getClassNamePrefix in interface JavaClassParent

getClasses

public JavaClass[] getClasses()

Deprecated. Use getNestedClasses() instead.


getDerivedClasses

public JavaClass[] getDerivedClasses()
Gets the known derived classes. That is, subclasses or implementing classes.

getFieldByName

public JavaField getFieldByName(String name)

getFields

public JavaField[] getFields()

getFullyQualifiedName

public String getFullyQualifiedName()

getImplementedInterfaces

public JavaClass[] getImplementedInterfaces()
Since:
1.3

getImplements

public Type[] getImplements()

getInnerClassByName

public JavaClass getInnerClassByName(String name)

Deprecated. old name for getNestedClassByName(String)


getInnerClasses

public JavaClass[] getInnerClasses()

Deprecated. old name for getNestedClasses()


getMethodBySignature

public JavaMethod getMethodBySignature(String name,
                                       Type[] parameterTypes)
Parameters:
name - method name
parameterTypes - parameter types or null if there are no parameters.
Returns:
the matching method or null if no match is found.

getMethodBySignature

public JavaMethod getMethodBySignature(String name,
                                       Type[] parameterTypes,
                                       boolean superclasses)

getMethods

public JavaMethod[] getMethods()

getMethods

public JavaMethod[] getMethods(boolean superclasses)
Since:
1.3

getMethodsBySignature

public JavaMethod[] getMethodsBySignature(String name,
                                          Type[] parameterTypes,
                                          boolean superclasses)

getNestedClassByName

public JavaClass getNestedClassByName(String name)
Specified by:
getNestedClassByName in interface JavaClassParent

getNestedClasses

public JavaClass[] getNestedClasses()
Since:
1.3

getPackage

public String getPackage()

getParentSource

public JavaSource getParentSource()
Specified by:
getParentSource in interface JavaClassParent

getSuperClass

public Type getSuperClass()

getSuperJavaClass

public JavaClass getSuperJavaClass()
Shorthand for getSuperClass().getJavaClass() with null checking.

getTagsByName

public DocletTag[] getTagsByName(String name,
                                 boolean superclasses)
Overrides:
getTagsByName in interface AbstractInheritableJavaEntity

isA

public boolean isA(String fullClassName)
Since:
1.3

isA

public boolean isA(JavaClass javaClass)
Since:
1.3

isEnum

public boolean isEnum()
is enum? (otherwise class or interface)

isInner

public boolean isInner()
Since:
1.3

isInterface

public boolean isInterface()
is interface? (otherwise enum or class)

resolveType

public String resolveType(String typeName)
Specified by:
resolveType in interface JavaClassParent

setAnnotation

public void setAnnotation(boolean isAnnotation)

setEnum

public void setEnum(boolean isEnum)

setImplementz

public void setImplementz(Type[] implementz)

setInterface

public void setInterface(boolean interfce)

setJavaClassCache

public void setJavaClassCache(JavaClassCache javaClassCache)

setSuperClass

public void setSuperClass(Type type)

writeBody

protected void writeBody(IndentBuffer result)
Overrides:
writeBody in interface AbstractJavaEntity