Top Description Fields Constructors Methods
com.github.javaparser.ast.expr

public Class TextBlockLiteralExpr

extends LiteralStringValueExpr
Class Inheritance
Imports
com.github.javaparser.TokenRange, com.github.javaparser.ast.AllFieldsConstructor, .Generated, .Node, com.github.javaparser.ast.visitor.CloneVisitor, .GenericVisitor, .VoidVisitor, com.github.javaparser.metamodel.JavaParserMetaModel, .TextBlockLiteralExprMetaModel, com.github.javaparser.utils.Pair, java.util.Arrays, .Optional, java.util.function.Consumer, java.util.stream.Stream

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.

Field Summary

Inherited from com.github.javaparser.ast.expr.LiteralStringValueExpr:
value

Constructor Summary

AccessConstructor and Description
public
TextBlockLiteralExpr()

public
TextBlockLiteralExpr(final String
the value of the literal
value)

Creates a text block literal expression from given string.

public
TextBlockLiteralExpr(TokenRange tokenRange, String value)

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

Method Summary

Modifier and TypeMethod and Description
public <R, A> R
accept(final GenericVisitor<R, A>
the visitor implementation
v, final A
the argument passed to the visitor (of type A)
arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.
public <A> void
accept(final VoidVisitor<A>
the visitor implementation
v, final A
any value relevant for the visitor (of type A)
arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.
public String

Returns:

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

public TextBlockLiteralExpr
asTextBlockLiteralExpr()

Overrides com.github.javaparser.ast.expr.Expression.asTextBlockLiteralExpr.

public TextBlockLiteralExpr
clone()

Overrides com.github.javaparser.ast.expr.LiteralStringValueExpr.clone.

Creates and returns a copy of this object.
private boolean

Returns:

is this string empty or filled only with whitespace?
emptyOrWhitespace(String rawLine)

public TextBlockLiteralExprMetaModel
getMetaModel()

Overrides com.github.javaparser.ast.expr.LiteralStringValueExpr.getMetaModel.

public void
ifTextBlockLiteralExpr(Consumer<TextBlockLiteralExpr> action)

Overrides com.github.javaparser.ast.expr.Expression.ifTextBlockLiteralExpr.

private int

Returns:

the amount of leading whitespaces.
indentSize(String s)

private boolean

Returns:

is the line with index lineNr the last line in rawLines?
isLastLine(String[] rawLines, Integer lineNr)

public boolean
isTextBlockLiteralExpr()

Overrides com.github.javaparser.ast.expr.Expression.isTextBlockLiteralExpr.

public boolean
remove(Node node)

Overrides com.github.javaparser.ast.expr.LiteralStringValueExpr.remove.

public boolean
replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.expr.LiteralStringValueExpr.replace.

public String

Returns:

The algorithm from String::stripIndent in JDK 13.
stripIndent()

public Stream<String>
stripIndentOfLines()

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

public Optional<TextBlockLiteralExpr>
toTextBlockLiteralExpr()

Overrides com.github.javaparser.ast.expr.Expression.toTextBlockLiteralExpr.

public String

Returns:

The algorithm ffrom String::translateEscapes in JDK 13.
translateEscapes()

private String
trimTrailing(String source)

Can be replaced when moving to JDK 11

Inherited from com.github.javaparser.ast.expr.LiteralStringValueExpr:
asLiteralStringValueExprgetValueifLiteralStringValueExprisLiteralStringValueExprsetValuetoLiteralStringValueExpr

Constructor Detail

TextBlockLiteralExprback to summary
public TextBlockLiteralExpr()
TextBlockLiteralExprback to summary
public TextBlockLiteralExpr(final String value)

Creates a text block literal expression from given string.

Parameters
value:String

the value of the literal

Annotations
@AllFieldsConstructor
TextBlockLiteralExprback to summary
public TextBlockLiteralExpr(TokenRange tokenRange, String value)

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

Annotations
@Generated:com.github.javaparser.generator.core.node.MainConstructorGenerator

Method Detail

acceptback to summary
public <R, A> R accept(final GenericVisitor<R, A> v, final A arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters
<R>
the type of the return value of the visitor
<A>
the type the user argument passed to the visitor
v:GenericVisitor<R, A>

the visitor implementation

arg:A

the argument passed to the visitor (of type A)

Returns:R

the result of the visit (of type R)

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.AcceptGenerator
acceptback to summary
public <A> void accept(final VoidVisitor<A> v, final A arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters
<A>
the type the argument passed for the visitor
v:VoidVisitor<A>

the visitor implementation

arg:A

any value relevant for the visitor (of type A)

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.AcceptGenerator
asStringback to summary
public String asString()
Returns:String

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

asTextBlockLiteralExprback to summary
public TextBlockLiteralExpr asTextBlockLiteralExpr()

Overrides com.github.javaparser.ast.expr.Expression.asTextBlockLiteralExpr.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
cloneback to summary
public TextBlockLiteralExpr clone()

Overrides com.github.javaparser.ast.expr.LiteralStringValueExpr.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression: 

x.clone() != x
will be true, and that the expression: 
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that: 
x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:TextBlockLiteralExpr

a clone of this instance.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.CloneGenerator
emptyOrWhitespaceback to summary
private boolean emptyOrWhitespace(String rawLine)
Returns:boolean

is this string empty or filled only with whitespace?

getMetaModelback to summary
public TextBlockLiteralExprMetaModel getMetaModel()

Overrides com.github.javaparser.ast.expr.LiteralStringValueExpr.getMetaModel.

Returns:TextBlockLiteralExprMetaModel

Doc from com.github.javaparser.ast.Node.getMetaModel.

get JavaParser specific node introspection information.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.GetMetaModelGenerator
ifTextBlockLiteralExprback to summary
public void ifTextBlockLiteralExpr(Consumer<TextBlockLiteralExpr> action)

Overrides com.github.javaparser.ast.expr.Expression.ifTextBlockLiteralExpr.

Annotations
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
indentSizeback to summary
private int indentSize(String s)
Returns:int

the amount of leading whitespaces.

isLastLineback to summary
private boolean isLastLine(String[] rawLines, Integer lineNr)
Returns:boolean

is the line with index lineNr the last line in rawLines?

isTextBlockLiteralExprback to summary
public boolean isTextBlockLiteralExpr()

Overrides com.github.javaparser.ast.expr.Expression.isTextBlockLiteralExpr.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
removeback to summary
public boolean remove(Node node)

Overrides com.github.javaparser.ast.expr.LiteralStringValueExpr.remove.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.RemoveMethodGenerator
replaceback to summary
public boolean replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.expr.LiteralStringValueExpr.replace.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.ReplaceMethodGenerator
stripIndentback to summary
public String stripIndent()
Returns:String

The algorithm from String::stripIndent in JDK 13.

stripIndentOfLinesback to summary
public Stream<String> stripIndentOfLines()

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

toTextBlockLiteralExprback to summary
public Optional<TextBlockLiteralExpr> toTextBlockLiteralExpr()

Overrides com.github.javaparser.ast.expr.Expression.toTextBlockLiteralExpr.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
translateEscapesback to summary
public String translateEscapes()
Returns:String

The algorithm ffrom String::translateEscapes in JDK 13.

trimTrailingback to summary
private String trimTrailing(String source)

Can be replaced when moving to JDK 11