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, PropertyAccessor

@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
boolean	equals(Object o)
String	getName()	Returns the name of this parameter.
T	getValue()	Returns the value bound to this parameter.
int	hashCode()
boolean	isAnon()	Query method to check if this is an anonymous parameter.
String	toString()	Most visitables will render themselves into a Cypher fragment preceded with the actual classname.
Parameter<?>	withValue(Object newValue)	Returns a new parameter with a bound value.

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, 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

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

getName

@API(status=STABLE,
     since="2023.1.0")
public String getName()

Returns the name of this parameter.

Returns:

the name of this parameter

Since:

2023.1.0

withValue

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

Returns a new parameter with a bound value.

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.

Returns:

the value bound to this parameter

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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}