com.thoughtworks.qdox.model

Class AbstractJavaEntity

public abstract class AbstractJavaEntity extends Object implements Serializable, Comparable

Field Summary
String	comment
int	lineNumber
protected List	modifiers
protected String	name
JavaClassParent	parent
DocletTag[]	tags

Constructor Summary
protected	AbstractJavaEntity(JavaClassParent parent, int lineNumber)

Method Summary
void	commentHeader(IndentBuffer buffer)
String	getComment()
int	getLineNumber()
String[]	getModifiers() Return list of modifiers as Strings. (public, private, protected, final, abstract, static)
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	isModifierPresent(String modifier)
boolean	isNative()
boolean	isPrivate()
boolean	isProtected()
boolean	isPublic()
boolean	isStatic()
boolean	isStrictfp()
boolean	isSynchronized()
boolean	isTransient()
boolean	isVolatile()
void	setComment(String comment)
void	setModifiers(String[] modifiers)
void	setName(String name)
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 Detail

comment

private String comment

lineNumber

private final int lineNumber

modifiers

protected List modifiers

name

protected String name

parent

private final JavaClassParent parent

tags

private DocletTag[] tags

Constructor Detail

AbstractJavaEntity

protected AbstractJavaEntity(JavaClassParent parent, int lineNumber)

Method Detail

commentHeader

void commentHeader(IndentBuffer buffer)

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

setComment

public void setComment(String comment)

setModifiers

public void setModifiers(String[] modifiers)

setName

public void setName(String name)

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)