com.github.javaparser.ast.comments

Class JavadocDescriptionElement

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.comments.JavadocDescriptionElement

All Implemented Interfaces:

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

Direct Known Subclasses:

JavadocInlineTag, JavadocSnippet

public abstract class JavadocDescriptionElement
extends Node

A node inside a JavadocDescription. Could either be a text snippet or inline tag.

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
JavadocDescriptionElement()
JavadocDescriptionElement(TokenRange tokenRange) This constructor is used by the parser and is considered private.

Method Summary

Modifier and Type	Method and Description
JavadocDescriptionElement	clone()
JavadocDescriptionElementMetaModel	getMetaModel()
boolean	remove(Node node)
boolean	replace(Node node, Node replacementNode)
abstract String	toText() Return the text content of the the description element.

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.visitor.Visitable

accept, accept

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

containsWithin, containsWithinRange, getBegin, getEnd

Constructor Detail

JavadocDescriptionElement

public JavadocDescriptionElement()

JavadocDescriptionElement

public JavadocDescriptionElement(TokenRange tokenRange)

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

Method Detail

toText

public abstract String toText()

Return the text content of the the description element.

Returns:

string content

remove

public boolean remove(Node node)

Overrides:

remove in class Node

replace

public boolean replace(Node node,
                       Node replacementNode)

Overrides:

replace in class Node

clone

public JavadocDescriptionElement clone()

Overrides:

clone in class Node

getMetaModel

public JavadocDescriptionElementMetaModel getMetaModel()

Overrides:

getMetaModel in class Node

Returns:

get JavaParser specific node introspection information.