com.thoughtworks.qdox.model
Class AbstractJavaEntity

java.lang.Object
  com.thoughtworks.qdox.model.AbstractJavaEntity

All Implemented Interfaces:

Serializable, Comparable

Direct Known Subclasses:

AbstractInheritableJavaEntity, JavaField

public abstract class AbstractJavaEntity
extends Object
implements Serializable, Comparable

See Also:

Serialized Form

Field Summary

protected List	modifiers
protected String	name

Constructor Summary

AbstractJavaEntity()

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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

name

protected String name

modifiers

protected List modifiers

Constructor Detail

AbstractJavaEntity

public AbstractJavaEntity()

Method Detail

getLineNumber

public int getLineNumber()

getName

public String getName()

getModifiers

public String[] getModifiers()

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

getComment

public String getComment()

getTags

public DocletTag[] getTags()

getAnnotations

public Annotation[] getAnnotations()

getTagsByName

public DocletTag[] getTagsByName(String name)

getTagByName

public DocletTag getTagByName(String name)

getNamedParameter

public String getNamedParameter(String tagName,
                                String parameterName)

Convenience method for getTagByName(String).getNamedParameter(String) that also checks for null tag.

Since:

1.3

toString

public String toString()

Overrides:

toString in class Object

write

protected void write(IndentBuffer result)

writeBody

protected abstract void writeBody(IndentBuffer result)

setName

public void setName(String name)

setModifiers

public void setModifiers(String[] modifiers)

setComment

public void setComment(String comment)

setTags

public void setTags(List tagList)

setAnnotations

public void setAnnotations(Annotation[] annotations)

isAbstract

public boolean isAbstract()

isPublic

public boolean isPublic()

isPrivate

public boolean isPrivate()

isProtected

public boolean isProtected()

isStatic

public boolean isStatic()

isFinal

public boolean isFinal()

isSynchronized

public boolean isSynchronized()

isTransient

public boolean isTransient()

isVolatile

public boolean isVolatile()

Since:

1.4

isNative

public boolean isNative()

Since:

1.4

isStrictfp

public boolean isStrictfp()

Since:

1.4

writeNonAccessibilityModifiers

protected void writeNonAccessibilityModifiers(IndentBuffer result)

writeAccessibilityModifier

protected void writeAccessibilityModifier(IndentBuffer result)

writeAllModifiers

protected void writeAllModifiers(IndentBuffer result)

getParent

public JavaClassParent getParent()

getSource

public JavaSource getSource()

setLineNumber

public void setLineNumber(int lineNumber)

setParent

public void setParent(JavaClassParent parent)