com.thoughtworks.qdox.model
Class AbstractJavaEntity

java.lang.Object
  extended bycom.thoughtworks.qdox.model.AbstractJavaEntity
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
AbstractInheritableJavaEntity, JavaField

public abstract class AbstractJavaEntity
extends java.lang.Object
implements java.io.Serializable

See Also:
Serialized Form

Field Summary
private  java.lang.String comment
           
protected  java.util.List modifiers
           
protected  java.lang.String name
           
private  DocletTag[] tags
           
 
Constructor Summary
AbstractJavaEntity()
           
 
Method Summary
(package private)  void commentHeader(IndentBuffer buffer)
           
 java.lang.String getComment()
           
 java.lang.String[] getModifiers()
          Return list of modifiers as Strings.
 java.lang.String getName()
           
 java.lang.String getNamedParameter(java.lang.String tagName, java.lang.String parameterName)
          Convenience method for getTagByName(String).getNamedParameter(String) that also checks for null tag.
 DocletTag getTagByName(java.lang.String name)
           
 DocletTag[] getTags()
           
 DocletTag[] getTagsByName(java.lang.String name)
           
 boolean isAbstract()
           
 boolean isFinal()
           
private  boolean isModifierPresent(java.lang.String modifier)
           
 boolean isPrivate()
           
 boolean isProtected()
           
 boolean isPublic()
           
 boolean isStatic()
           
 boolean isSynchronized()
           
 boolean isTransient()
           
 void setComment(java.lang.String comment)
           
 void setModifiers(java.lang.String[] modifiers)
           
 void setName(java.lang.String name)
           
 void setTags(java.util.List tags)
           
 java.lang.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
 

Field Detail

name

protected java.lang.String name

modifiers

protected java.util.List modifiers

comment

private java.lang.String comment

tags

private DocletTag[] tags
Constructor Detail

AbstractJavaEntity

public AbstractJavaEntity()
Method Detail

getName

public java.lang.String getName()

getModifiers

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


getComment

public java.lang.String getComment()

getTags

public DocletTag[] getTags()

getTagsByName

public DocletTag[] getTagsByName(java.lang.String name)

getTagByName

public DocletTag getTagByName(java.lang.String name)

getNamedParameter

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

Since:
1.3

commentHeader

void commentHeader(IndentBuffer buffer)

toString

public java.lang.String toString()

write

protected void write(IndentBuffer result)

writeBody

protected abstract void writeBody(IndentBuffer result)

setName

public void setName(java.lang.String name)

setModifiers

public void setModifiers(java.lang.String[] modifiers)

setComment

public void setComment(java.lang.String comment)

setTags

public void setTags(java.util.List tags)

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

isModifierPresent

private boolean isModifierPresent(java.lang.String modifier)

writeNonAccessibilityModifiers

protected void writeNonAccessibilityModifiers(IndentBuffer result)

writeAccessibilityModifier

protected void writeAccessibilityModifier(IndentBuffer result)

writeAllModifiers

protected void writeAllModifiers(IndentBuffer result)