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

public Class StringLiteralExpr

extends LiteralStringValueExpr
Class Inheritance
Imports
com.github.javaparser.ast.AllFieldsConstructor, .Node, .Generated, com.github.javaparser.ast.visitor.CloneVisitor, .GenericVisitor, .VoidVisitor, com.github.javaparser.metamodel.JavaParserMetaModel, .StringLiteralExprMetaModel, com.github.javaparser.utils.StringEscapeUtils, .Utils, com.github.javaparser.TokenRange, java.util.function.Consumer, java.util.Optional
A literal string.
"Hello World!"
"\"\n"
"™"
"™"
"💩"
Author
Julio Vilmar Gesser

Field Summary

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

Constructor Summary

AccessConstructor and Description
public
StringLiteralExpr()

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

Creates a string literal expression from given string.

public
StringLiteralExpr(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 unescaped literal value
asString()

public StringLiteralExpr
asStringLiteralExpr()

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

public StringLiteralExpr
clone()

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

Creates and returns a copy of this object.
public StringLiteralExprMetaModel
getMetaModel()

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

public void
ifStringLiteralExpr(Consumer<StringLiteralExpr> action)

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

public boolean
isStringLiteralExpr()

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

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 StringLiteralExpr

Returns:

self
setEscapedValue(String
the new literal value
value)

Sets the content of this expressions to given value.

public StringLiteralExpr

Returns:

this literal expression
setString(String
unescaped string
value)

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

public Optional<StringLiteralExpr>
toStringLiteralExpr()

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

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

Constructor Detail

StringLiteralExprback to summary
public StringLiteralExpr()
StringLiteralExprback to summary
public StringLiteralExpr(final String value)

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

Parameters
value:String

the value of the literal

Annotations
@AllFieldsConstructor
StringLiteralExprback to summary
public StringLiteralExpr(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 unescaped literal value

asStringLiteralExprback to summary
public StringLiteralExpr asStringLiteralExpr()

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

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
cloneback to summary
public StringLiteralExpr 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:StringLiteralExpr

a clone of this instance.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.CloneGenerator
getMetaModelback to summary
public StringLiteralExprMetaModel getMetaModel()

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

Returns:StringLiteralExprMetaModel

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

get JavaParser specific node introspection information.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.GetMetaModelGenerator
ifStringLiteralExprback to summary
public void ifStringLiteralExpr(Consumer<StringLiteralExpr> action)

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

Annotations
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
isStringLiteralExprback to summary
public boolean isStringLiteralExpr()

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

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
setEscapedValueback to summary
public StringLiteralExpr setEscapedValue(String value)

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

Parameters
value:String

the new literal value

Returns:StringLiteralExpr

self

setStringback to summary
public StringLiteralExpr setString(String value)

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

Parameters
value:String

unescaped string

Returns:StringLiteralExpr

this literal expression

toStringLiteralExprback to summary
public Optional<StringLiteralExpr> toStringLiteralExpr()

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

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator