com.github.javaparser.ast.comments

Class JavadocSnippet

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.comments.JavadocDescriptionElement

com.github.javaparser.ast.comments.JavadocSnippet

All Implemented Interfaces:

NodeWithRange<Node>, NodeWithTokenRange<Node>, Observable, Visitable, HasParentNode<Node>, Cloneable

public class JavadocSnippet
extends JavadocDescriptionElement

A JavadocSnippet node containing string content.

Author:

Simon Sirak & David Johansson

Nested Class Summary

Nested classes/interfaces inherited from class com.github.javaparser.ast.Node

Node.BreadthFirstIterator, Node.DirectChildrenIterator, Node.ObserverRegistrationMode, Node.ParentsVisitor, Node.Parsedness, Node.PostOrderIterator, Node.PreOrderIterator, Node.TreeTraversal

Field Summary

Fields inherited from class com.github.javaparser.ast.Node

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, NODE_BY_BEGIN_POSITION, prettyPrinterNoCommentsConfiguration, SYMBOL_RESOLVER_KEY

Constructor Summary

Constructors

Constructor and Description
JavadocSnippet()
JavadocSnippet(String text)
JavadocSnippet(TokenRange tokenRange, String text) This constructor is used by the parser and is considered private.

Method Summary

Modifier and Type	Method and Description
<R,A> R	accept(GenericVisitor<R,A> v, A arg) Accept method for visitor support.
<A> void	accept(VoidVisitor<A> v, A arg) Accept method for visitor support.
JavadocSnippet	clone()
JavadocSnippetMetaModel	getMetaModel()
String	getText() Return the text content of the the snippet.
boolean	remove(Node node)
boolean	replace(Node node, Node replacementNode)
JavadocSnippet	setText(String text) Set text of current node.
String	toText() Return the text content of the the snippet.

Methods inherited from class com.github.javaparser.ast.Node

addOrphanComment, containsData, customInitialization, equals, findAll, findAll, findCompilationUnit, findFirst, findFirst, findFirst, findRootNode, getAllContainedComments, getChildNodes, getChildNodesByType, getComment, getData, getDataKeys, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getRange, getSymbolResolver, getTokenRange, getToStringPrettyPrinterConfiguration, hashCode, isAncestorOf, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, removeComment, removeData, removeForced, removeOrphanComment, replace, setAsParentNodeOf, setAsParentNodeOf, setBlockComment, setComment, setData, setLineComment, setParentNode, setParsed, setRange, setTokenRange, setToStringPrettyPrinterConfiguration, stream, stream, toString, toString, tryAddImportToParentCompilationUnit, unregister, walk, walk, walk

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.javaparser.HasParentNode

findAncestor, findAncestor, isDescendantOf

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithRange

containsWithin, containsWithinRange, getBegin, getEnd

Constructor Detail

JavadocSnippet

public JavadocSnippet()

JavadocSnippet

public JavadocSnippet(String text)

JavadocSnippet

public JavadocSnippet(TokenRange tokenRange,
                      String text)

This constructor is used by the parser and is considered private.

Method Detail

setText

public JavadocSnippet setText(String text)

Set text of current node.

Parameters:

text - string text

Returns:

new version of current object

toText

public String toText()

Return the text content of the the snippet.

Specified by:

toText in class JavadocDescriptionElement

Returns:

string content

getText

public String getText()

Return the text content of the the snippet.

Returns:

string content

accept

public <R,A> R accept(GenericVisitor<R,A> v,
                      A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Type Parameters:

R - the type of the return value of the visitor

A - the type the user argument passed to the visitor

Parameters:

v - the visitor implementation

arg - the argument passed to the visitor (of type A)

Returns:

the result of the visit (of type R)

accept

public <A> void accept(VoidVisitor<A> v,
                       A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Type Parameters:

A - the type the argument passed for the visitor

Parameters:

v - the visitor implementation

arg - any value relevant for the visitor (of type A)

remove

public boolean remove(Node node)

Overrides:

remove in class JavadocDescriptionElement

replace

public boolean replace(Node node,
                       Node replacementNode)

Overrides:

replace in class JavadocDescriptionElement

clone

public JavadocSnippet clone()

Overrides:

clone in class JavadocDescriptionElement

getMetaModel

public JavadocSnippetMetaModel getMetaModel()

Overrides:

getMetaModel in class JavadocDescriptionElement

Returns:

get JavaParser specific node introspection information.