Module org.neo4j.cypherdsl.core

Package org.neo4j.cypherdsl.core

Class Parameter<T>

java.lang.Object

org.neo4j.cypherdsl.core.Parameter<T>

Type Parameters:

T - The type of the parameter. Defaults to Object for a parameter without a value from which to derive the actual type.

All Implemented Interfaces:

Visitable, Expression

@API(status=STABLE,
     since="1.0")
public final class Parameter<T>
extends Object
implements Expression

Represents a named parameter inside a Cypher statement.

Since:

1.0

Author:

Michael J. Simons, Andreas Berger

Method Summary

Modifier and Type	Method	Description
T	getValue()
boolean	isAnon()	Query method to check if this is an anonymous parameter.
Parameter<?>	withValue(Object newValue)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

Method Details

isAnon

@API(status=STABLE,
     since="2021.0.0")
public boolean isAnon()

Query method to check if this is an anonymous parameter.

Returns:

True if this is an anonymous parameter

Since:

2021.1.0

withValue

@API(status=STABLE,
     since="2021.0.0")
public Parameter<?> withValue(Object newValue)

Parameters:

newValue - The new value that should be bound by this parameter

Returns:

A new parameter with a bound value

Since:

2021.0.0

getValue

@API(status=INTERNAL,
     since="2021.1.0")
public T getValue()

Returns:

the value bound to this parameter