com.thoughtworks.qdox.model
Class AbstractJavaEntity

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

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

See Also:
Serialized Form

Field Summary
private  Annotation[] annotations
           
private  java.lang.String comment
           
private  int lineNumber
           
protected  java.util.List modifiers
           
protected  java.lang.String name
           
private  JavaClassParent parent
           
private  DocletTag[] tags
           
 
Constructor Summary
AbstractJavaEntity()
           
 
Method Summary
(package private)  void commentHeader(IndentBuffer buffer)
           
 Annotation[] getAnnotations()
           
 java.lang.String getComment()
           
 int getLineNumber()
           
 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.
 JavaClassParent getParent()
           
 JavaSource getSource()
           
 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 isNative()
           
 boolean isPrivate()
           
 boolean isProtected()
           
 boolean isPublic()
           
 boolean isStatic()
           
 boolean isStrictfp()
           
 boolean isSynchronized()
           
 boolean isTransient()
           
 boolean isVolatile()
           
 void setAnnotations(Annotation[] annotations)
           
 void setComment(java.lang.String comment)
           
 void setLineNumber(int lineNumber)
           
 void setModifiers(java.lang.String[] modifiers)
           
 void setName(java.lang.String name)
           
 void setParent(JavaClassParent parent)
           
 void setTags(java.util.List tagList)
           
 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
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Field Detail

name

protected java.lang.String name

modifiers

protected java.util.List modifiers

comment

private java.lang.String comment

tags

private DocletTag[] tags

annotations

private Annotation[] annotations

parent

private JavaClassParent parent

lineNumber

private int lineNumber
Constructor Detail

AbstractJavaEntity

public AbstractJavaEntity()
Method Detail

getLineNumber

public int getLineNumber()

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

getAnnotations

public Annotation[] getAnnotations()

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()
Overrides:
toString in class java.lang.Object

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

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)

getParent

public JavaClassParent getParent()

getSource

public JavaSource getSource()

setLineNumber

public void setLineNumber(int lineNumber)

setParent

public void setParent(JavaClassParent parent)