Package spoon.reflect.code

Interface CtJavaDocTag

All Superinterfaces:

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

All Known Implementing Classes:

CtJavaDocTagImpl

public interface CtJavaDocTag
extends CtElement

This code element defines a javadoc tag Example:

Since:

name description

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CtJavaDocTag.TagType	Define the possible type for a tag

Field Summary

Fields

Modifier and Type	Field	Description
static String	JAVADOC_TAG_PREFIX	The tag prefix

Method Summary

Modifier and Type	Method	Description
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

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, toString, toStringDebug, updateAllParentsBelow

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

filterChildren, map, map

Methods inherited from interface spoon.reflect.visitor.CtVisitable

accept

Methods inherited from interface spoon.processing.FactoryAccessor

getFactory, setFactory

Field Details

JAVADOC_TAG_PREFIX

static final String JAVADOC_TAG_PREFIX

The tag prefix

See Also:

Constant Field Values

Method Details

getType

CtJavaDocTag.TagType getType()

The type of the tag

Returns:

the type of the tag

setType

<E extends CtJavaDocTag> E setType(String type)

Define the type of the tag

Parameters:

type - the type name

setType

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

Define the type of the tag

Parameters:

type - the new type

getRealName

String getRealName()

The type of the tag

Returns:

the type of the tag

setRealName

<E extends CtJavaDocTag> E setRealName(String realName)

Define the real name of tag type

Parameters:

realName - the real name of type

getContent

String getContent()

Get the content of the atg

Returns:

the content of the tag

setContent

<E extends CtJavaDocTag> E setContent(String content)

Define the content of the tag

Parameters:

content - the new content of the tag

getParam

String getParam()

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

Returns:

the parameter

setParam

<E extends CtJavaDocTag> E setParam(String param)

Define a parameter

Parameters:

param - the parameter

clone

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