spoon.support.reflect.code

Class CtCommentImpl

java.lang.Object

spoon.support.reflect.declaration.CtElementImpl

spoon.support.reflect.code.CtCodeElementImpl

spoon.support.reflect.code.CtStatementImpl

spoon.support.reflect.code.CtCommentImpl

All Implemented Interfaces:

Serializable, Cloneable, FactoryAccessor, CtCodeElement, CtComment, CtStatement, SourcePositionHolder, CtElement, CtQueryable, CtVisitable

Direct Known Subclasses:

CtJavaDocImpl

public class CtCommentImpl
extends CtStatementImpl
implements CtComment

See Also:

Serialized Form

Nested Class Summary

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

CtComment.CommentType

Field Summary

Fields

Modifier and Type	Field and Description
protected String	content

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

ERROR_MESSAGE_TO_STRING, LOGGER, parent

Fields inherited from interface spoon.reflect.code.CtComment

LINE_SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
	CtCommentImpl()
protected	CtCommentImpl(CtComment.CommentType type)

Method Summary

Modifier and Type	Method and Description
<E extends CtComment> E	_setRawContent(String content) FOR ADVANCED USAGE ONLY Set the comment content, without cleaning the comment, if the cleaning behavior to get a canonical version does not work for you.
void	accept(CtVisitor visitor) Accepts a visitor
CtJavaDoc	asJavaDoc() Utility method to for casting the object, throws an exception if not of the correct type
CtComment	clone() Clone the element which calls this method in a new object.
boolean	equals(Object o) The comments are not printed during the CtElement equality.
CtComment.CommentType	getCommentType() Get the type of the comment
String	getContent() Get the content of the comment
String	getRawContent()
int	hashCode()
<E extends CtComment> E	setCommentType(CtComment.CommentType commentType)
<E extends CtComment> E	setContent(String content)

Methods inherited from class spoon.support.reflect.code.CtStatementImpl

getLabel, insertAfter, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertBefore, setLabel

Methods inherited from class spoon.support.reflect.code.CtCodeElementImpl

partiallyEvaluate

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

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, putMetadata, removeAnnotation, removeComment, replace, replace, setAllMetadata, setAnnotations, setComments, setDocComment, setFactory, setImplicit, setParent, setPosition, setPositions, setValueByRole, toString, unmodifiableList, updateAllParentsBelow

Methods inherited from class java.lang.Object

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

Methods inherited from interface spoon.reflect.code.CtStatement

getLabel, insertAfter, insertAfter, insertBefore, insertBefore, setLabel

Methods inherited from interface spoon.reflect.code.CtCodeElement

partiallyEvaluate

Methods inherited from interface spoon.reflect.declaration.CtElement

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, putMetadata, removeAnnotation, removeComment, replace, replace, setAllMetadata, setAnnotations, setComments, setDocComment, setImplicit, setParent, setPosition, setPositions, setValueByRole, updateAllParentsBelow

Methods inherited from interface spoon.processing.FactoryAccessor

getFactory, setFactory

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

filterChildren, map, map

Methods inherited from interface spoon.reflect.cu.SourcePositionHolder

getOriginalSourceFragment

Field Detail

content

protected String content

Constructor Detail

CtCommentImpl

public CtCommentImpl()

CtCommentImpl

protected CtCommentImpl(CtComment.CommentType type)

Method Detail

getContent

public String getContent()

Description copied from interface: CtComment

Get the content of the comment

Specified by:

getContent in interface CtComment

Returns:

the content of the comment

getRawContent

public String getRawContent()

Specified by:

getRawContent in interface CtComment

Returns:

the original raw comment from the source file including comment prefix and suffix, indentation (including TABs) original EOLs, based on the attached position object (the returned value is "derived" from the position). If the file pointed to in the position object does not exist on disk anymore, then the empty string "" is returned Note: the call of CtComment.setContent(String) doesn't influence the returned value, only the value of the position object.

setContent

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

Specified by:

setContent in interface CtComment

_setRawContent

public <E extends CtComment> E _setRawContent(String content)

FOR ADVANCED USAGE ONLY Set the comment content, without cleaning the comment, if the cleaning behavior to get a canonical version does not work for you. Does not ensure any AST contract such as calling the change listener You have to cast your comment to CtCommentImpl, it's not beautiful, but it's known :-)

getCommentType

public CtComment.CommentType getCommentType()

Description copied from interface: CtComment

Get the type of the comment

Specified by:

getCommentType in interface CtComment

Returns:

the comment type

setCommentType

public <E extends CtComment> E setCommentType(CtComment.CommentType commentType)

Specified by:

setCommentType in interface CtComment

accept

public void accept(CtVisitor visitor)

Description copied from interface: CtVisitable

Accepts a visitor

Specified by:

accept in interface CtVisitable

equals

public boolean equals(Object o)

The comments are not printed during the CtElement equality. The method is this overridden for CtComment.

Overrides:

equals in class CtElementImpl

hashCode

public int hashCode()

Overrides:

hashCode in class CtElementImpl

clone

public CtComment 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 CtCodeElement

Specified by:

clone in interface CtComment

Specified by:

clone in interface CtStatement

Specified by:

clone in interface CtElement

Overrides:

clone in class CtStatementImpl

asJavaDoc

public CtJavaDoc asJavaDoc()

Description copied from interface: CtComment

Utility method to for casting the object, throws an exception if not of the correct type

Specified by:

asJavaDoc in interface CtComment