com.thoughtworks.qdox.model

Class AbstractJavaEntity

Implemented Interfaces:
Comparable, Serializable
Known Direct Subclasses:
AbstractInheritableJavaEntity, JavaField

public abstract class AbstractJavaEntity
extends java.lang.Object
implements Serializable, Comparable

Field Summary

protected List
modifiers
protected String
name

Method Summary

Annotation[]
getAnnotations()
String
getComment()
int
getLineNumber()
String[]
getModifiers()
Return list of modifiers as Strings.
String
getName()
String
getNamedParameter(String tagName, String parameterName)
Convenience method for getTagByName(String).getNamedParameter(String) that also checks for null tag.
JavaClassParent
getParent()
JavaSource
getSource()
DocletTag
getTagByName(String name)
DocletTag[]
getTags()
DocletTag[]
getTagsByName(String name)
boolean
isAbstract()
boolean
isFinal()
boolean
isNative()
boolean
isPrivate()
boolean
isProtected()
boolean
isPublic()
boolean
isStatic()
boolean
isStrictfp()
boolean
isSynchronized()
boolean
isTransient()
boolean
isVolatile()
void
setAnnotations(Annotation[] annotations)
void
setComment(String comment)
void
setLineNumber(int lineNumber)
void
setModifiers(String[] modifiers)
void
setName(String name)
void
setParent(JavaClassParent parent)
void
setTags(List tagList)
String
toString()
protected void
write(IndentBuffer result)
protected void
writeAccessibilityModifier(IndentBuffer result)
protected void
writeAllModifiers(IndentBuffer result)
protected abstract void
writeBody(IndentBuffer result)
protected void
writeNonAccessibilityModifiers(IndentBuffer result)

Field Details

modifiers

protected List modifiers

name

protected String name

Method Details

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()

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)