Package org.jdbi.v3.core.statement

Class ParsedSql

java.lang.Object

org.jdbi.v3.core.statement.ParsedSql

public final class ParsedSql
extends java.lang.Object

The SQL and parameters parsed from an SQL statement.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParsedSql.Builder	Fluent builder for ParsedSql instances.

Field Summary

Fields

Modifier and Type	Field	Description
private ParsedParameters	parameters
(package private) static java.lang.String	POSITIONAL_PARAM
private java.lang.String	sql

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ParsedSql(java.lang.String sql, ParsedParameters parameters)

Method Summary

Modifier and Type	Method	Description
static ParsedSql.Builder	builder()	Creates a new ParsedSql builder.
boolean	equals(java.lang.Object o)
ParsedParameters	getParameters()	The set of parameters parsed from the input SQL string.
java.lang.String	getSql()	Returns a SQL string suitable for use with a JDBC PreparedStatement.
int	hashCode()
static ParsedSql	of(java.lang.String sql, ParsedParameters parameters)	A static factory of ParsedSql instances.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

POSITIONAL_PARAM

static final java.lang.String POSITIONAL_PARAM

See Also:

Constant Field Values

sql

private final java.lang.String sql

parameters

private final ParsedParameters parameters

Constructor Detail

ParsedSql

private ParsedSql(java.lang.String sql,
                  ParsedParameters parameters)

Method Detail

getSql

public java.lang.String getSql()

Returns a SQL string suitable for use with a JDBC PreparedStatement.

Returns:

a SQL string suitable for use with a JDBC PreparedStatement.

getParameters

public ParsedParameters getParameters()

The set of parameters parsed from the input SQL string.

Returns:

the set of parameters parsed from the input SQL string.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

of

public static ParsedSql of(java.lang.String sql,
                           ParsedParameters parameters)

A static factory of ParsedSql instances. The statement may contain only positional parameters (the "?" character). If your SQL code contains named parameters (for example variables preceded by a colon) then you have to replace them with positional parameters and specify the mapping in the ParsedParameters. You cannot mix named and positional parameters in one SQL statement.

Parameters:

sql - the SQL code containing only positional parameters

parameters - the ordered list of named parameters, or positional parameters

Returns:

New ParsedSql instance

See Also:

ParsedParameters.positional(int), ParsedParameters.named(List)

builder

public static ParsedSql.Builder builder()

Creates a new ParsedSql builder.

Returns:

a builder instance.