Module org.neo4j.cypherdsl.core

Package org.neo4j.cypherdsl.core

Class StringLiteral

java.lang.Object

org.neo4j.cypherdsl.core.StringLiteral

All Implemented Interfaces:

Visitable, Expression, Literal<CharSequence>

@API(status=STABLE,
     since="1.0")
public final class StringLiteral
extends Object

The string representation of a string literal will be a quoted Cypher string in single tickmarks with escaped reserved characters.

Since:

1.0

Author:

Michael J. Simons

Nested Class Summary

Nested classes/interfaces inherited from interface org.neo4j.cypherdsl.core.Literal

Literal.UnsupportedLiteralException

Field Summary

Fields

Modifier and Type	Field	Description
protected final CharSequence	content	The content of this literal.

Method Summary

Modifier and Type	Method	Description
@NotNull String	asString()	The string representation should be designed in such a way the a renderer can use it correctly in the given context of the literal, i.e.
boolean	equals(Object o)
CharSequence	getContent()	Retrieves the actual content of this literal, might not be supported by all literals.
int	hashCode()
String	toString()	Most visitables will render themselves into a Cypher fragment preceded with the actual classname.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.neo4j.cypherdsl.core.Expression

add, as, as, ascending, asCondition, concat, contains, descending, divide, endsWith, eq, gt, gte, hasSize, in, includesAll, includesAny, isEmpty, isEqualTo, isFalse, isNotEqualTo, isNotNull, isNull, isTrue, lt, lte, matches, matches, multiply, ne, pow, property, remainder, size, sorted, startsWith, subtract

Methods inherited from interface org.neo4j.cypherdsl.core.ast.Visitable

accept

Field Details

content

protected final CharSequence content

The content of this literal.

Method Details

asString

@NotNull
public @NotNull String asString()

Description copied from interface: Literal

The string representation should be designed in such a way the a renderer can use it correctly in the given context of the literal, i.e. a literal containing a string should quote that string and escape all reserved characters.

Returns:

A string representation to be used literally in a cypher statement.

getContent

public CharSequence getContent()

Description copied from interface: Literal

Retrieves the actual content of this literal, might not be supported by all literals.

Returns:

the actual content of this literal

toString

public String toString()

Description copied from interface: Visitable

Most visitables will render themselves into a Cypher fragment preceded with the actual classname. The representation however is not cached - in contrast to the ones for full statements. Using toString is recommended for debugging purposes mainly, and not for production use.

The concrete classname has been prepended to help debugging and actually to discourage using fragments to build queries without explicitly rendering them, either as statement or going through the renderer on purpose.

Specified by:

toString in interface Visitable

Overrides:

toString in class Object

Returns:

A string representation of this visitable formatted as Classname{cypher=value}

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object