Package spoon.support.reflect.code

Class CtJavaDocTagImpl

java.lang.Object

spoon.support.reflect.declaration.CtElementImpl

spoon.support.reflect.code.CtJavaDocTagImpl

All Implemented Interfaces:

Serializable, Cloneable, FactoryAccessor, CtJavaDocTag, SourcePositionHolder, CtElement, CtQueryable, CtVisitable

public class CtJavaDocTagImpl
extends CtElementImpl
implements CtJavaDocTag

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface spoon.reflect.code.CtJavaDocTag

CtJavaDocTag.TagType

Field Summary

Fields inherited from class spoon.support.reflect.declaration.CtElementImpl

ERROR_MESSAGE_TO_STRING, factory, LOGGER, parent

Fields inherited from interface spoon.reflect.code.CtJavaDocTag

JAVADOC_TAG_PREFIX

Constructor Summary

Constructors

Constructor	Description
CtJavaDocTagImpl()

Method Summary

Modifier and Type	Method	Description
void	accept(CtVisitor visitor)	Accepts a visitor
CtJavaDocTag	clone()	Clone the element which calls this method in a new object.
String	getContent()	Get the content of the atg
String	getParam()	Get the parameter of the tag return null when none is specified (only for @param and @throws)
String	getRealName()	The type of the tag
CtJavaDocTag.TagType	getType()	The type of the tag
<E extends CtJavaDocTag> E	setContent(String content)	Define the content of the tag
<E extends CtJavaDocTag> E	setParam(String param)	Define a parameter
<E extends CtJavaDocTag> E	setRealName(String realName)	Define the real name of tag type
<E extends CtJavaDocTag> E	setType(String type)	Define the type of the tag
<E extends CtJavaDocTag> E	setType(CtJavaDocTag.TagType type)	Define the type of the tag
String	toString()

Methods inherited from class spoon.support.reflect.declaration.CtElementImpl

addAnnotation, addComment, asIterable, comment, delete, descendantIterator, emptyList, emptySet, equals, filterChildren, getAllMetadata, getAnnotatedChildren, getAnnotation, getAnnotation, getAnnotations, getComments, getDirectChildren, getDocComment, getElements, getFactory, getMetadata, getMetadataKeys, getOriginalSourceFragment, getParent, getParent, getParent, getPath, getPosition, getReferencedTypes, getRoleInParent, getShortRepresentation, getValueByRole, hasAnnotation, hashCode, hasParent, isImplicit, isParentInitialized, map, map, prettyprint, putMetadata, removeAnnotation, removeComment, replace, replace, setAllMetadata, setAnnotations, setComments, setDocComment, setFactory, setImplicit, setParent, setPosition, setPositions, setValueByRole, toStringDebug, unmodifiableList, updateAllParentsBelow

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface spoon.reflect.declaration.CtElement

addAnnotation, addComment, asIterable, delete, descendantIterator, getAllMetadata, getAnnotatedChildren, getAnnotation, getAnnotation, getAnnotations, getComments, getDirectChildren, getDocComment, getElements, getMetadata, getMetadataKeys, getOriginalSourceFragment, 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, toStringDebug, updateAllParentsBelow

Methods inherited from interface spoon.reflect.visitor.chain.CtQueryable

filterChildren, map, map

Methods inherited from interface spoon.processing.FactoryAccessor

getFactory, setFactory

Constructor Details

CtJavaDocTagImpl

public CtJavaDocTagImpl()

Method Details

getType

public CtJavaDocTag.TagType getType()

Description copied from interface: CtJavaDocTag

The type of the tag

Specified by:

getType in interface CtJavaDocTag

Returns:

the type of the tag

setType

public <E extends CtJavaDocTag> E setType(String type)

Description copied from interface: CtJavaDocTag

Define the type of the tag

Specified by:

setType in interface CtJavaDocTag

Parameters:

type - the type name

setType

public <E extends CtJavaDocTag> E setType(CtJavaDocTag.TagType type)

Description copied from interface: CtJavaDocTag

Define the type of the tag

Specified by:

setType in interface CtJavaDocTag

Parameters:

type - the new type

setRealName

public <E extends CtJavaDocTag> E setRealName(String realName)

Description copied from interface: CtJavaDocTag

Define the real name of tag type

Specified by:

setRealName in interface CtJavaDocTag

Parameters:

realName - the real name of type

getRealName

public String getRealName()

Description copied from interface: CtJavaDocTag

The type of the tag

Specified by:

getRealName in interface CtJavaDocTag

Returns:

the type of the tag

getContent

public String getContent()

Description copied from interface: CtJavaDocTag

Get the content of the atg

Specified by:

getContent in interface CtJavaDocTag

Returns:

the content of the tag

setContent

public <E extends CtJavaDocTag> E setContent(String content)

Description copied from interface: CtJavaDocTag

Define the content of the tag

Specified by:

setContent in interface CtJavaDocTag

Parameters:

content - the new content of the tag

getParam

public String getParam()

Description copied from interface: CtJavaDocTag

Get the parameter of the tag return null when none is specified (only for @param and @throws)

Specified by:

getParam in interface CtJavaDocTag

Returns:

the parameter

setParam

public <E extends CtJavaDocTag> E setParam(String param)

Description copied from interface: CtJavaDocTag

Define a parameter

Specified by:

setParam in interface CtJavaDocTag

Parameters:

param - the parameter

accept

public void accept(CtVisitor visitor)

Description copied from interface: CtVisitable

Accepts a visitor

Specified by:

accept in interface CtVisitable

clone

public CtJavaDocTag clone()

Description copied from interface: CtElement

Clone the element which calls this method in a new object. Note that that references are kept as is, and thus, so if you clone whole classes or methods, some parts of the cloned element (eg executable references) may still point to the initial element. In this case, consider using methods Refactoring.copyType(CtType) and Refactoring.copyMethod(CtMethod) instead which does additional work beyond cloning.

Specified by:

clone in interface CtElement

Specified by:

clone in interface CtJavaDocTag

Overrides:

clone in class CtElementImpl

Returns:

a clone of this element. All children are cloned, but the parent of the returned clone is set to null.

toString

public String toString()

Specified by:

toString in interface CtElement

Overrides:

toString in class CtElementImpl

Returns:

the source code of this element according to the setting of Environment.getPrettyPrintingMode().