Package com.github.javaparser.ast.expr

Class TextBlockLiteralExpr

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.expr.Expression

com.github.javaparser.ast.expr.LiteralExpr

com.github.javaparser.ast.expr.LiteralStringValueExpr

com.github.javaparser.ast.expr.TextBlockLiteralExpr

All Implemented Interfaces:

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

public class TextBlockLiteralExpr
extends LiteralStringValueExpr

A text block

Java 13-

A text block is a multi-line string. It was introduced in JEP 355. The content of "value" is byte-for-byte exactly what is in the source code.

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.expr.LiteralStringValueExpr

value

Fields inherited from class com.github.javaparser.ast.expr.Expression

EXCLUDE_ENCLOSED_EXPR, IS_NOT_ENCLOSED_EXPR

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

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, LINE_SEPARATOR_KEY, NODE_BY_BEGIN_POSITION, PHANTOM_KEY, prettyPrinterNoCommentsConfiguration, PRINTER_KEY, SYMBOL_RESOLVER_KEY

Constructor Summary

Constructors

Constructor	Description
TextBlockLiteralExpr()
TextBlockLiteralExpr(TokenRange tokenRange, String value)	This constructor is used by the parser and is considered private.
TextBlockLiteralExpr(String value)	Creates a text block literal expression from given string.

Method Summary

Modifier and Type	Method	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.
String	asString()
TextBlockLiteralExpr	asTextBlockLiteralExpr()
TextBlockLiteralExpr	clone()
TextBlockLiteralExprMetaModel	getMetaModel()
void	ifTextBlockLiteralExpr(Consumer<TextBlockLiteralExpr> action)
boolean	isTextBlockLiteralExpr()
String	stripIndent()
Stream<String>	stripIndentOfLines()	Most of the algorithm for stripIndent, stopping just before concatenating all the lines into a single string.
Optional<TextBlockLiteralExpr>	toTextBlockLiteralExpr()
String	translateEscapes()

Methods inherited from class com.github.javaparser.ast.expr.LiteralStringValueExpr

asLiteralStringValueExpr, getValue, ifLiteralStringValueExpr, isLiteralStringValueExpr, setValue, toLiteralStringValueExpr

Methods inherited from class com.github.javaparser.ast.expr.LiteralExpr

asLiteralExpr, ifLiteralExpr, isLiteralExpr, toLiteralExpr

Methods inherited from class com.github.javaparser.ast.expr.Expression

appearsInAssignmentContext, appearsInInvocationContext, asAnnotationExpr, asArrayAccessExpr, asArrayCreationExpr, asArrayInitializerExpr, asAssignExpr, asBinaryExpr, asBooleanLiteralExpr, asCastExpr, asCharLiteralExpr, asClassExpr, asConditionalExpr, asDoubleLiteralExpr, asEnclosedExpr, asFieldAccessExpr, asInstanceOfExpr, asIntegerLiteralExpr, asLambdaExpr, asLongLiteralExpr, asMarkerAnnotationExpr, asMethodCallExpr, asMethodReferenceExpr, asNameExpr, asNormalAnnotationExpr, asNullLiteralExpr, asObjectCreationExpr, asPatternExpr, asRecordPatternExpr, asSingleMemberAnnotationExpr, asStringLiteralExpr, asSuperExpr, asSwitchExpr, asThisExpr, asTypeExpr, asTypePatternExpr, asUnaryExpr, asVariableDeclarationExpr, calculateResolvedType, elidesTypeArguments, ifAnnotationExpr, ifArrayAccessExpr, ifArrayCreationExpr, ifArrayInitializerExpr, ifAssignExpr, ifBinaryExpr, ifBooleanLiteralExpr, ifCastExpr, ifCharLiteralExpr, ifClassExpr, ifConditionalExpr, ifDoubleLiteralExpr, ifEnclosedExpr, ifFieldAccessExpr, ifInstanceOfExpr, ifIntegerLiteralExpr, ifLambdaExpr, ifLongLiteralExpr, ifMarkerAnnotationExpr, ifMethodCallExpr, ifMethodReferenceExpr, ifNameExpr, ifNormalAnnotationExpr, ifNullLiteralExpr, ifObjectCreationExpr, ifPatternExpr, ifRecordPatternExpr, ifSingleMemberAnnotationExpr, ifStringLiteralExpr, ifSuperExpr, ifSwitchExpr, ifThisExpr, ifTypeExpr, ifTypePatternExpr, ifUnaryExpr, ifVariableDeclarationExpr, isAnnotationExpr, isArrayAccessExpr, isArrayCreationExpr, isArrayInitializerExpr, isAssignExpr, isAssignmentContext, isBinaryExpr, isBooleanLiteralExpr, isCastExpr, isCharLiteralExpr, isClassExpr, isConditionalExpr, isDoubleLiteralExpr, isEnclosedExpr, isFieldAccessExpr, isInstanceOfExpr, isIntegerLiteralExpr, isInvocationContext, isLambdaExpr, isLongLiteralExpr, isMarkerAnnotationExpr, isMethodCallExpr, isMethodReferenceExpr, isNameExpr, isNormalAnnotationExpr, isNullLiteralExpr, isObjectCreationExpr, isPatternExpr, isPolyExpression, isQualified, isRecordPatternExpr, isSingleMemberAnnotationExpr, isStandaloneExpression, isStringLiteralExpr, isSuperExpr, isSwitchExpr, isThisExpr, isTypeExpr, isTypePatternExpr, isUnaryExpr, isVariableDeclarationExpr, toAnnotationExpr, toArrayAccessExpr, toArrayCreationExpr, toArrayInitializerExpr, toAssignExpr, toBinaryExpr, toBooleanLiteralExpr, toCastExpr, toCharLiteralExpr, toClassExpr, toConditionalExpr, toDoubleLiteralExpr, toEnclosedExpr, toFieldAccessExpr, toInstanceOfExpr, toIntegerLiteralExpr, toLambdaExpr, toLongLiteralExpr, toMarkerAnnotationExpr, toMethodCallExpr, toMethodReferenceExpr, toNameExpr, toNormalAnnotationExpr, toNullLiteralExpr, toObjectCreationExpr, toPatternExpr, toRecordPatternExpr, toSingleMemberAnnotationExpr, toStringLiteralExpr, toSuperExpr, toSwitchExpr, toThisExpr, toTypeExpr, toTypePatternExpr, toUnaryExpr, toVariableDeclarationExpr

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

addOrphanComment, containsData, createDefaultPrinter, createDefaultPrinter, customInitialization, equals, findAll, findAll, findAll, findByRange, findCompilationUnit, findData, findFirst, findFirst, findFirst, findRootNode, getAllContainedComments, getChildNodes, getChildNodesByType, getComment, getData, getDataKeys, getDefaultPrinterConfiguration, getLineEndingStyle, getLineEndingStyleOrDefault, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getPrinter, getPrinter, getRange, getSymbolResolver, getTokenRange, hashCode, hasScope, isAncestorOf, isPhantom, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, remove, removeComment, removeData, removeForced, removeOrphanComment, replace, replace, setAsParentNodeOf, setAsParentNodeOf, setBlockComment, setComment, setData, setLineComment, setParentNode, setParsed, setRange, setTokenRange, 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, findAncestor, hasParentNode, isDescendantOf

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

containsWithin, containsWithinRange, getBegin, getEnd, hasRange

Constructor Detail

TextBlockLiteralExpr

public TextBlockLiteralExpr()

TextBlockLiteralExpr

public TextBlockLiteralExpr(String value)

Creates a text block literal expression from given string.

Parameters:

value - the value of the literal

TextBlockLiteralExpr

public TextBlockLiteralExpr(TokenRange tokenRange,
                            String value)

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

Method Detail

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)

isTextBlockLiteralExpr

public boolean isTextBlockLiteralExpr()

Overrides:

isTextBlockLiteralExpr in class Expression

asTextBlockLiteralExpr

public TextBlockLiteralExpr asTextBlockLiteralExpr()

Overrides:

asTextBlockLiteralExpr in class Expression

toTextBlockLiteralExpr

public Optional<TextBlockLiteralExpr> toTextBlockLiteralExpr()

Overrides:

toTextBlockLiteralExpr in class Expression

ifTextBlockLiteralExpr

public void ifTextBlockLiteralExpr(Consumer<TextBlockLiteralExpr> action)

Overrides:

ifTextBlockLiteralExpr in class Expression

clone

public TextBlockLiteralExpr clone()

Overrides:

clone in class LiteralStringValueExpr

getMetaModel

public TextBlockLiteralExprMetaModel getMetaModel()

Overrides:

getMetaModel in class LiteralStringValueExpr

Returns:

get JavaParser specific node introspection information.

stripIndentOfLines

public Stream<String> stripIndentOfLines()

Most of the algorithm for stripIndent, stopping just before concatenating all the lines into a single string. Useful for tools.

stripIndent

public String stripIndent()

Returns:

The algorithm from String::stripIndent in JDK 13.

translateEscapes

public String translateEscapes()

Returns:

The algorithm from String::translateEscapes in JDK 13.

asString

public String asString()

Returns:

the final string value of this text block after all processing.