Module org.neo4j.cypherdsl.core

Package org.neo4j.cypherdsl.core

Interface Literal<T>

Type Parameters:

T - type of content

All Superinterfaces:

Expression, PropertyAccessor, Visitable

All Known Implementing Classes:

Asterisk, BooleanLiteral, ListLiteral, MapLiteral, NullLiteral, NumberLiteral, StringLiteral, TemporalLiteral

@API(status=STABLE,
     since="1.0")
public interface Literal<T>
extends Expression

Represents a literal with an optional content.

Since:

1.0

Author:

Michael J. Simons

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	Literal.UnsupportedLiteralException	Thrown when a given object cannot be used as a Cypher-DSL-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. a literal containing a string should quote that string and escape all reserved characters.
default T	getContent()	Retrieves the actual content of this literal, might not be supported by all literals.

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, property, remainder, size, sorted, startsWith, subtract

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

property

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

accept, toString

Method Details

asString

@NotNull
@Contract(pure=true)
@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. 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

default T getContent()

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

Returns:

the actual content of this literal

Since:

2023.4.0