com.thoughtworks.qdox.model.impl

Class AbstractBaseJavaEntity

java.lang.Object

com.thoughtworks.qdox.model.impl.AbstractJavaModel

com.thoughtworks.qdox.model.impl.AbstractBaseJavaEntity

All Implemented Interfaces:

JavaModel, Serializable

Direct Known Subclasses:

AbstractJavaEntity, DefaultJavaPackage, DefaultJavaParameter

public abstract class AbstractBaseJavaEntity
extends AbstractJavaModel
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractBaseJavaEntity()

Method Summary

Modifier and Type	Method and Description
List<JavaAnnotation>	getAnnotations()
String	getComment()
JavaClass	getDeclaringClass() Not every entity has a parentClass, but AnnotationFieldRef requires access to it.
String	getNamedParameter(String tagName, String parameterName) Convenience method for getTagByName(String).getNamedParameter(String) that also checks for null tag.
JavaSource	getSource()
DocletTag	getTagByName(String name)
List<DocletTag>	getTags()
List<DocletTag>	getTagsByName(String name)
void	setAnnotations(List<JavaAnnotation> annotations)
void	setComment(String comment)
void	setSource(JavaSource source)
void	setTags(List<DocletTag> tagList)

Methods inherited from class com.thoughtworks.qdox.model.impl.AbstractJavaModel

getLineNumber, getModelWriter, setLineNumber, setModelWriterFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.thoughtworks.qdox.model.JavaModel

getCodeBlock

Constructor Detail

AbstractBaseJavaEntity

public AbstractBaseJavaEntity()

Method Detail

getSource

public JavaSource getSource()

setSource

public void setSource(JavaSource source)

getAnnotations

public List<JavaAnnotation> getAnnotations()

setAnnotations

public void setAnnotations(List<JavaAnnotation> annotations)

getDeclaringClass

public JavaClass getDeclaringClass()

Not every entity has a parentClass, but AnnotationFieldRef requires access to it. When used with JavaClass, don't confuse this with getSuperClass()

Returns:

the surrounding class

getComment

public String getComment()

setComment

public void setComment(String comment)

getTags

public List<DocletTag> getTags()

getTagsByName

public List<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.

Parameters:

tagName - the name of the docletTag

parameterName - the name of the parameter

Returns:

the value of the named parameter

Since:

1.3

setTags

public void setTags(List<DocletTag> tagList)