com.thoughtworks.qdox.model

Class JavaClass

public class JavaClass extends AbstractInheritableJavaEntity implements JavaClassParent

Author: Joe Walnes Aslak Hellesøy

Constructor Summary
JavaClass()
JavaClass(String name)
Method Summary
voidaddClass(JavaClass cls)
voidaddField(JavaField javaField)
voidaddMethod(JavaMethod meth)
TypeasType()
intcompareTo(Object o)
BeanProperty[]getBeanProperties()
Gets bean properties without looking in superclasses or interfaces.
BeanProperty[]getBeanProperties(boolean superclasses)
BeanPropertygetBeanProperty(String propertyName)
Gets bean property without looking in superclasses or interfaces.
BeanPropertygetBeanProperty(String propertyName, boolean superclasses)
JavaClass[]getClasses()
StringgetClassNamePrefix()
JavaClass[]getDerivedClasses()
Gets the known derived classes.
JavaFieldgetFieldByName(String name)
JavaField[]getFields()
StringgetFullyQualifiedName()
JavaClass[]getImplementedInterfaces()
Type[]getImplements()
JavaClassgetInnerClassByName(String name)
JavaClass[]getInnerClasses()
JavaClassContextgetJavaClassContext()
JavaMethodgetMethodBySignature(String name, Type[] parameterTypes)
JavaMethodgetMethodBySignature(String name, Type[] parameterTypes, boolean superclasses)
JavaMethod[]getMethods()
JavaMethod[]getMethods(boolean superclasses)
JavaMethod[]getMethodsBySignature(String name, Type[] parameterTypes, boolean superclasses)
JavaClassgetNestedClassByName(String name)
JavaClass[]getNestedClasses()
JavaPackagegetPackage()
JavaSourcegetParentSource()
TypegetSuperClass()
JavaClassgetSuperJavaClass()
Shorthand for getSuperClass().getJavaClass() with null checking.
DocletTag[]getTagsByName(String name, boolean superclasses)
booleanisA(String fullClassName)
booleanisA(JavaClass javaClass)
booleanisEnum()
is enum?
booleanisInner()
booleanisInterface()
is interface?
StringresolveType(String typeName)
voidsetAnnotation(boolean isAnnotation)
voidsetEnum(boolean isEnum)
voidsetImplementz(Type[] implementz)
voidsetInterface(boolean interfce)
voidsetJavaClassContext(JavaClassContext context)
voidsetJavaPackage(JavaPackage javaPackage)
voidsetSuperClass(Type type)
StringtoString()
protected voidwriteBody(IndentBuffer result)

Constructor Detail

JavaClass

public JavaClass()

JavaClass

public JavaClass(String name)

Method Detail

addClass

public void addClass(JavaClass cls)

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

getClasses

public JavaClass[] getClasses()

Deprecated: Use getNestedClasses instead.

getClassNamePrefix

public String getClassNamePrefix()

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

getInnerClasses

public JavaClass[] getInnerClasses()

Deprecated: old name for getNestedClasses

getJavaClassContext

public JavaClassContext getJavaClassContext()

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)

getNestedClasses

public JavaClass[] getNestedClasses()

Since: 1.3

getPackage

public JavaPackage getPackage()

getParentSource

public JavaSource getParentSource()

getSuperClass

public Type getSuperClass()

getSuperJavaClass

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

getTagsByName

public DocletTag[] getTagsByName(String name, boolean superclasses)

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)

setAnnotation

public void setAnnotation(boolean isAnnotation)

setEnum

public void setEnum(boolean isEnum)

setImplementz

public void setImplementz(Type[] implementz)

setInterface

public void setInterface(boolean interfce)

setJavaClassContext

public void setJavaClassContext(JavaClassContext context)

setJavaPackage

public void setJavaPackage(JavaPackage javaPackage)

setSuperClass

public void setSuperClass(Type type)

toString

public String toString()

See Also: http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html#toString()

writeBody

protected void writeBody(IndentBuffer result)