public class CtJavaDocImpl extends CtCommentImpl implements CtJavaDoc
CtComment.CommentType
content
ERROR_MESSAGE_TO_STRING, LOGGER, parent
LINE_SEPARATOR
Constructor and Description |
---|
CtJavaDocImpl() |
Modifier and Type | Method and Description |
---|---|
void |
accept(CtVisitor visitor)
Accepts a visitor
|
<E extends CtJavaDoc> |
addTag(CtJavaDocTag tag)
Add a new tag at the end of the list
|
<E extends CtJavaDoc> |
addTag(int index,
CtJavaDocTag tag)
Add a new tag at the index position
|
CtJavaDoc |
clone()
Clone the element which calls this method in a new object.
|
List<JavadocDescriptionElement> |
getJavadocElements()
Returns the list of parsed Javadoc elements
|
String |
getLongDescription()
Get the long description of the javadoc
|
String |
getShortDescription()
Get the short summary of the javadoc (first sentence of the javadoc)
|
List<CtJavaDocTag> |
getTags()
Get all the tag of the javadoc
|
<E extends CtJavaDoc> |
removeTag(CtJavaDocTag tag)
Remove a specific tag
|
<E extends CtJavaDoc> |
removeTag(int index)
Remove a tag from the index
|
<E extends CtComment> |
setContent(String content)
Parses the content string to split in two: the description and the Javadoc tags
|
<E extends CtJavaDoc> |
setTags(List<CtJavaDocTag> tags)
Define the list of tags
|
_setRawContent, asJavaDoc, equals, getCommentType, getContent, getRawContent, hashCode, setCommentType
getLabel, insertAfter, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertBefore, setLabel
partiallyEvaluate
addAnnotation, addComment, asIterable, delete, descendantIterator, emptyList, emptySet, filterChildren, getAllMetadata, getAnnotatedChildren, getAnnotation, getAnnotation, getAnnotations, getComments, getDirectChildren, getDocComment, getElements, getFactory, getMetadata, getMetadataKeys, getOriginalSourceFragment, getParent, getParent, getParent, getPath, getPosition, getReferencedTypes, getRoleInParent, getShortRepresentation, getValueByRole, hasAnnotation, hasParent, isImplicit, isParentInitialized, map, map, prettyprint, putMetadata, removeAnnotation, removeComment, replace, replace, setAllMetadata, setAnnotations, setComments, setDocComment, setFactory, setImplicit, setParent, setPosition, setPositions, setValueByRole, toString, toStringDebug, unmodifiableList, updateAllParentsBelow
finalize, getClass, notify, notifyAll, wait, wait, wait
asJavaDoc, getCommentType, getContent, getRawContent, setCommentType
getLabel, insertAfter, insertAfter, insertBefore, insertBefore, setLabel
partiallyEvaluate
addAnnotation, addComment, asIterable, delete, descendantIterator, getAllMetadata, getAnnotatedChildren, getAnnotation, getAnnotation, getAnnotations, getComments, getDirectChildren, getDocComment, getElements, getMetadata, getMetadataKeys, getParent, getParent, getParent, getPath, getPosition, getReferencedTypes, getRoleInParent, getShortRepresentation, getValueByRole, hasAnnotation, hasParent, isImplicit, isParentInitialized, prettyprint, putMetadata, removeAnnotation, removeComment, replace, replace, setAllMetadata, setAnnotations, setComments, setDocComment, setImplicit, setParent, setPosition, setPositions, setValueByRole, toString, toStringDebug, updateAllParentsBelow
getFactory, setFactory
filterChildren, map, map
getOriginalSourceFragment
public List<CtJavaDocTag> getTags()
CtJavaDoc
public <E extends CtJavaDoc> E setTags(List<CtJavaDocTag> tags)
CtJavaDoc
public <E extends CtJavaDoc> E addTag(CtJavaDocTag tag)
CtJavaDoc
public <E extends CtJavaDoc> E addTag(int index, CtJavaDocTag tag)
CtJavaDoc
public <E extends CtJavaDoc> E removeTag(int index)
CtJavaDoc
public <E extends CtJavaDoc> E removeTag(CtJavaDocTag tag)
CtJavaDoc
public String getShortDescription()
CtJavaDoc
getShortDescription
in interface CtJavaDoc
public <E extends CtComment> E setContent(String content)
setContent
in interface CtComment
setContent
in class CtCommentImpl
public String getLongDescription()
CtJavaDoc
getLongDescription
in interface CtJavaDoc
public void accept(CtVisitor visitor)
CtVisitable
accept
in interface CtVisitable
accept
in class CtCommentImpl
public CtJavaDoc clone()
CtElement
Refactoring.copyType(CtType)
and Refactoring.copyMethod(CtMethod)
instead which does additional work beyond cloning.clone
in interface CtCodeElement
clone
in interface CtComment
clone
in interface CtJavaDoc
clone
in interface CtStatement
clone
in interface CtElement
clone
in class CtCommentImpl
public List<JavadocDescriptionElement> getJavadocElements()
CtJavaDoc
getJavadocElements
in interface CtJavaDoc
Copyright © 2007–2019 Inria. All rights reserved.