Package 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
,java.io.Serializable
- Direct Known Subclasses:
AbstractJavaEntity
,DefaultJavaPackage
,DefaultJavaParameter
public abstract class AbstractBaseJavaEntity extends AbstractJavaModel implements java.io.Serializable
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description AbstractBaseJavaEntity()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<JavaAnnotation>
getAnnotations()
java.lang.String
getComment()
JavaClass
getDeclaringClass()
Not every entity has a parentClass, but AnnotationFieldRef requires access to it.java.lang.String
getNamedParameter(java.lang.String tagName, java.lang.String parameterName)
Convenience method forgetTagByName(String).getNamedParameter(String)
that also checks for null tag.JavaSource
getSource()
DocletTag
getTagByName(java.lang.String name)
java.util.List<DocletTag>
getTags()
java.util.List<DocletTag>
getTagsByName(java.lang.String name)
void
setAnnotations(java.util.List<JavaAnnotation> annotations)
void
setComment(java.lang.String comment)
void
setSource(JavaSource source)
void
setTags(java.util.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
-
-
-
-
Method Detail
-
getSource
public JavaSource getSource()
-
setSource
public void setSource(JavaSource source)
-
getAnnotations
public java.util.List<JavaAnnotation> getAnnotations()
-
setAnnotations
public void setAnnotations(java.util.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 java.lang.String getComment()
-
setComment
public void setComment(java.lang.String comment)
-
getTags
public java.util.List<DocletTag> getTags()
-
getTagsByName
public java.util.List<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 forgetTagByName(String).getNamedParameter(String)
that also checks for null tag.- Parameters:
tagName
- the name of the docletTagparameterName
- the name of the parameter- Returns:
- the value of the named parameter
- Since:
- 1.3
-
setTags
public void setTags(java.util.List<DocletTag> tagList)
-
-