Package com.github.javaparser.ast.expr

Class StringLiteralExpr

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.StringLiteralExpr

All Implemented Interfaces:

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

public final class StringLiteralExpr
extends LiteralStringValueExpr

A literal string.
"Hello World!"
"\"\n"
"™"
"™"
"💩"

Author:

Julio Vilmar Gesser

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.Node

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, NODE_BY_BEGIN_POSITION, prettyPrinterNoCommentsConfiguration, SYMBOL_RESOLVER_KEY

Constructor Summary

Constructors

Constructor	Description
StringLiteralExpr()
StringLiteralExpr(TokenRange tokenRange, String value)	This constructor is used by the parser and is considered private.
StringLiteralExpr(String value)	Creates a string 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()
StringLiteralExpr	asStringLiteralExpr()
StringLiteralExpr	clone()
static StringLiteralExpr	escape(String string)	Deprecated. Use StringLiteralExpr(String) instead.
StringLiteralExprMetaModel	getMetaModel()
void	ifStringLiteralExpr(Consumer<StringLiteralExpr> action)
boolean	isStringLiteralExpr()
boolean	remove(Node node)
boolean	replace(Node node, Node replacementNode)
StringLiteralExpr	setEscapedValue(String value)	Sets the content of this expressions to given value.
StringLiteralExpr	setString(String value)	Escapes the given string from special characters and uses it as the literal value.
Optional<StringLiteralExpr>	toStringLiteralExpr()

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

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, asSingleMemberAnnotationExpr, asSuperExpr, asThisExpr, asTypeExpr, asUnaryExpr, asVariableDeclarationExpr, calculateResolvedType, 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, ifSingleMemberAnnotationExpr, ifSuperExpr, ifThisExpr, ifTypeExpr, ifUnaryExpr, ifVariableDeclarationExpr, isAnnotationExpr, isArrayAccessExpr, isArrayCreationExpr, isArrayInitializerExpr, isAssignExpr, isBinaryExpr, isBooleanLiteralExpr, isCastExpr, isCharLiteralExpr, isClassExpr, isConditionalExpr, isDoubleLiteralExpr, isEnclosedExpr, isFieldAccessExpr, isInstanceOfExpr, isIntegerLiteralExpr, isLambdaExpr, isLongLiteralExpr, isMarkerAnnotationExpr, isMethodCallExpr, isMethodReferenceExpr, isNameExpr, isNormalAnnotationExpr, isNullLiteralExpr, isObjectCreationExpr, isSingleMemberAnnotationExpr, isSuperExpr, isThisExpr, isTypeExpr, 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, toSingleMemberAnnotationExpr, toSuperExpr, toThisExpr, toTypeExpr, toUnaryExpr, toVariableDeclarationExpr

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, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getRange, getSymbolResolver, getTokenRange, hasComment, hashCode, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, removeComment, removeData, removeForced, removeOrphanComment, 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, findParent, getAncestorOfType

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

containsWithin, getBegin, getEnd, isPositionedAfter, isPositionedBefore

Constructor Detail

StringLiteralExpr

public StringLiteralExpr()

StringLiteralExpr

public StringLiteralExpr(String value)

Creates a string literal expression from given string. Escapes EOL characters.

Parameters:

value - the value of the literal

StringLiteralExpr

public StringLiteralExpr(TokenRange tokenRange,
                         String value)

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

Method Detail

escape

@Deprecated
public static StringLiteralExpr escape(String string)

Deprecated.

Use StringLiteralExpr(String) instead.

Utility method that creates a new StringLiteralExpr. Escapes EOL characters.

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 LiteralStringValueExpr

setEscapedValue

public StringLiteralExpr setEscapedValue(String value)

Sets the content of this expressions to given value. Escapes EOL characters.

Parameters:

value - the new literal value

Returns:

self

asString

public String asString()

Returns:

the unescaped literal value

setString

public StringLiteralExpr setString(String value)

Escapes the given string from special characters and uses it as the literal value.

Parameters:

value - unescaped string

Returns:

this literal expression

clone

public StringLiteralExpr clone()

Overrides:

clone in class LiteralStringValueExpr

getMetaModel

public StringLiteralExprMetaModel getMetaModel()

Overrides:

getMetaModel in class LiteralStringValueExpr

Returns:

get JavaParser specific node introspection information.

replace

public boolean replace(Node node,
                       Node replacementNode)

Overrides:

replace in class LiteralStringValueExpr

isStringLiteralExpr

public boolean isStringLiteralExpr()

Overrides:

isStringLiteralExpr in class Expression

asStringLiteralExpr

public StringLiteralExpr asStringLiteralExpr()

Overrides:

asStringLiteralExpr in class Expression

ifStringLiteralExpr

public void ifStringLiteralExpr(Consumer<StringLiteralExpr> action)

Overrides:

ifStringLiteralExpr in class Expression

toStringLiteralExpr

public Optional<StringLiteralExpr> toStringLiteralExpr()

Overrides:

toStringLiteralExpr in class Expression