com.thoughtworks.qdox.model

Class AbstractJavaEntity

public abstract class AbstractJavaEntity extends Object implements Serializable, Comparable

Field Summary
Annotation[]annotations
Stringcomment
intlineNumber
protected Listmodifiers
protected Stringname
JavaClassParentparent
DocletTag[]tags
Method Summary
voidcommentHeader(IndentBuffer buffer)
Annotation[]getAnnotations()
StringgetComment()
intgetLineNumber()
String[]getModifiers()
Return list of modifiers as Strings. (public, private, protected, final, abstract, static)
StringgetName()
StringgetNamedParameter(String tagName, String parameterName)
Convenience method for getTagByName(String).getNamedParameter(String) that also checks for null tag.
JavaClassParentgetParent()
JavaSourcegetSource()
DocletTaggetTagByName(String name)
DocletTag[]getTags()
DocletTag[]getTagsByName(String name)
booleanisAbstract()
booleanisFinal()
booleanisModifierPresent(String modifier)
booleanisNative()
booleanisPrivate()
booleanisProtected()
booleanisPublic()
booleanisStatic()
booleanisStrictfp()
booleanisSynchronized()
booleanisTransient()
booleanisVolatile()
voidsetAnnotations(Annotation[] annotations)
voidsetComment(String comment)
voidsetLineNumber(int lineNumber)
voidsetModifiers(String[] modifiers)
voidsetName(String name)
voidsetParent(JavaClassParent parent)
voidsetTags(List tagList)
StringtoString()
protected voidwrite(IndentBuffer result)
protected voidwriteAccessibilityModifier(IndentBuffer result)
protected voidwriteAllModifiers(IndentBuffer result)
protected abstract voidwriteBody(IndentBuffer result)
protected voidwriteNonAccessibilityModifiers(IndentBuffer result)

Field Detail

annotations

private Annotation[] annotations

comment

private String comment

lineNumber

private int lineNumber

modifiers

protected List modifiers

name

protected String name

parent

private JavaClassParent parent

tags

private DocletTag[] tags

Method Detail

commentHeader

void commentHeader(IndentBuffer buffer)

getAnnotations

public Annotation[] getAnnotations()

getComment

public String getComment()

getLineNumber

public int getLineNumber()

getModifiers

public String[] getModifiers()
Return list of modifiers as Strings. (public, private, protected, final, abstract, static)

getName

public String getName()

getNamedParameter

public String getNamedParameter(String tagName, String parameterName)
Convenience method for getTagByName(String).getNamedParameter(String) that also checks for null tag.

Since: 1.3

getParent

public JavaClassParent getParent()

getSource

public JavaSource getSource()

getTagByName

public DocletTag getTagByName(String name)

getTags

public DocletTag[] getTags()

getTagsByName

public DocletTag[] getTagsByName(String name)

isAbstract

public boolean isAbstract()

isFinal

public boolean isFinal()

isModifierPresent

private boolean isModifierPresent(String modifier)

isNative

public boolean isNative()

Since: 1.4

isPrivate

public boolean isPrivate()

isProtected

public boolean isProtected()

isPublic

public boolean isPublic()

isStatic

public boolean isStatic()

isStrictfp

public boolean isStrictfp()

Since: 1.4

isSynchronized

public boolean isSynchronized()

isTransient

public boolean isTransient()

isVolatile

public boolean isVolatile()

Since: 1.4

setAnnotations

public void setAnnotations(Annotation[] annotations)

setComment

public void setComment(String comment)

setLineNumber

public void setLineNumber(int lineNumber)

setModifiers

public void setModifiers(String[] modifiers)

setName

public void setName(String name)

setParent

public void setParent(JavaClassParent parent)

setTags

public void setTags(List tagList)

toString

public String toString()

write

protected void write(IndentBuffer result)

writeAccessibilityModifier

protected void writeAccessibilityModifier(IndentBuffer result)

writeAllModifiers

protected void writeAllModifiers(IndentBuffer result)

writeBody

protected abstract void writeBody(IndentBuffer result)

writeNonAccessibilityModifiers

protected void writeNonAccessibilityModifiers(IndentBuffer result)