com.thoughtworks.qdox.model
Class AbstractJavaEntity

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

public abstract class AbstractJavaEntity
extends AbstractBaseJavaEntity
implements Comparable

See Also:
Serialized Form

Field Summary
protected  List modifiers
           
 
Fields inherited from class com.thoughtworks.qdox.model.AbstractBaseJavaEntity
name, parent
 
Constructor Summary
AbstractJavaEntity()
           
 
Method Summary
 String getCodeBlock()
           
 String getComment()
           
 String[] getModifiers()
          Return list of modifiers as Strings.
 String getNamedParameter(String tagName, String parameterName)
          Convenience method for getTagByName(String).getNamedParameter(String) that also checks for null tag.
 JavaClass getParentClass()
          Not every entity has a parentClass, but AnnotationFieldRef requires access to it.
 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 setComment(String comment)
           
 void setModifiers(String[] modifiers)
           
 void setParentClass(JavaClass parentClass)
           
 void setTags(List tagList)
           
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 com.thoughtworks.qdox.model.AbstractBaseJavaEntity
getAnnotations, getLineNumber, getName, getParent, setAnnotations, setLineNumber, setName, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Field Detail

modifiers

protected List modifiers
Constructor Detail

AbstractJavaEntity

public AbstractJavaEntity()
Method Detail

getModifiers

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


getComment

public String getComment()

getTags

public DocletTag[] getTags()

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

getCodeBlock

public String getCodeBlock()

write

protected void write(IndentBuffer result)

writeBody

protected abstract void writeBody(IndentBuffer result)

setModifiers

public void setModifiers(String[] modifiers)

setComment

public void setComment(String comment)

setTags

public void setTags(List tagList)

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)

getSource

public JavaSource getSource()

setParentClass

public void setParentClass(JavaClass parentClass)

getParentClass

public JavaClass getParentClass()
Description copied from class: AbstractBaseJavaEntity
Not every entity has a parentClass, but AnnotationFieldRef requires access to it.

Overrides:
getParentClass in class AbstractBaseJavaEntity
Returns:


Copyright © 2002-2011. All Rights Reserved.