org.neo4j.driver.v1

Class Statement

java.lang.Object

org.neo4j.driver.v1.Statement

@Immutable
public class Statement
extends Object

An executable statement, i.e. the statements' text and its parameters.

Since:

1.0

See Also:

Session, Transaction, StatementResult, StatementResult.consume(), ResultSummary

Constructor Summary

Constructors

Constructor and Description
Statement(String text) Create a new statement.
Statement(String text, Map<String,Object> parameters) Create a new statement.
Statement(String text, Value parameters) Create a new statement.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
int	hashCode()
Value	parameters()
String	text()
String	toString()
Statement	withParameters(Map<String,Object> newParameters)
Statement	withParameters(Value newParameters)
Statement	withText(String newText)
Statement	withUpdatedParameters(Value updates) Create a new statement with new parameters derived by updating this' statement's parameters using the given updates.

Methods inherited from class java.lang.Object

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

Constructor Detail

Statement

public Statement(String text,
         Value parameters)

Create a new statement.

Parameters:

text - the statement text

parameters - the statement parameters

Statement

public Statement(String text,
         Map<String,Object> parameters)

Create a new statement.

Parameters:

text - the statement text

parameters - the statement parameters

Statement

public Statement(String text)

Create a new statement.

Parameters:

text - the statement text

Method Detail

text

public String text()

Returns:

the statement's text

parameters

public Value parameters()

Returns:

the statement's parameters

withText

public Statement withText(String newText)

Parameters:

newText - the new statement's text

Returns:

a new statement with updated text

withParameters

public Statement withParameters(Value newParameters)

Parameters:

newParameters - the new statement's parameters

Returns:

a new statement with updated parameters

withParameters

public Statement withParameters(Map<String,Object> newParameters)

Parameters:

newParameters - the new statement's parameters

Returns:

a new statement with updated parameters

withUpdatedParameters

public Statement withUpdatedParameters(Value updates)

Create a new statement with new parameters derived by updating this' statement's parameters using the given updates. Every update key that points to a null value will be removed from the new statement's parameters. All other entries will just replace any existing parameter in the new statement.

Parameters:

updates - describing how to update the parameters

Returns:

a new statement with updated parameters

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object