PostgreSQL JDBC Driver 42.7.2 · org.postgresql.core.v3.SimpleParameterList

Modifier and Type	Field and Description
private static final byte	BINARY
private final @Nullable byte[][]	encoded
private final byte[]	flags
private static final byte	IN
private static final byte	INOUT
private static final Object	NULL_OBJECT Marker object representing NULL; this distinguishes "parameter never set" from "parameter set to null".
private static final byte	OUT
private final int[]	paramTypes
private final @Nullable Object[]	paramValues
private int	pos
private static final byte	TEXT
private final @Nullable TypeTransferModeRegistry	transferModeRegistry

Access	Constructor and Description
pack-priv	SimpleParameterList(int paramCount, @Nullable TypeTransferModeRegistry transferModeRegistry)

Method Summary

Modifier and Type	Method and Description
public void	appendAll(ParameterList of parameters to append with. list) Implements org.postgresql.core.ParameterList.appendAll. Use this operation to append more parameters to the current list.
private void	bind(int index, Object value, int oid, byte binary)
public void	checkAllParametersSet() Implements org.postgresql.core.v3.V3ParameterList.checkAllParametersSet. Ensure that all parameters in this list have been assigned values.
public void	clear() Implements org.postgresql.core.ParameterList.clear. Unbind all parameter values bound in this list.
public void	convertFunctionOutParameters() Implements org.postgresql.core.v3.V3ParameterList.convertFunctionOutParameters. Convert any function output parameters to the correct type (void) and set an ignorable value for it.
public ParameterList	copy() Implements org.postgresql.core.ParameterList.copy. Perform a shallow copy of this ParameterList, returning a new instance (still suitable for passing to the owning Query).
private byte	direction(@Positive int index)
public @Nullable byte[][]	getEncoding() Implements org.postgresql.core.v3.V3ParameterList.getEncoding. Return the encoding for each parameter.
public byte[]	getFlags() Implements org.postgresql.core.v3.V3ParameterList.getFlags. Return the flags for each parameter.
public @NonNegative int	getInParameterCount() Implements org.postgresql.core.ParameterList.getInParameterCount. Get the number of IN parameters in this list.
public @NonNegative int	getOutParameterCount() Implements org.postgresql.core.ParameterList.getOutParameterCount. Get the number of OUT parameters in this list.
public @NonNegative int	getParameterCount() Implements org.postgresql.core.ParameterList.getParameterCount. Get the number of parameters in this list.
public int[]	getParamTypes() Implements org.postgresql.core.v3.V3ParameterList.getParamTypes. Return the parameter type information.
public @Nullable SimpleParameterList[]	getSubparams() Implements org.postgresql.core.v3.V3ParameterList.getSubparams. Return a list of the SimpleParameterList objects that make up this parameter list.
pack-priv int	getTypeOID(@Positive int index)
public int[]	getTypeOIDs() Implements org.postgresql.core.ParameterList.getTypeOIDs. Return the oids of the parameters in this list.
pack-priv int	getV3Length(@Positive int index)
public @Nullable Object[]	getValues() Implements org.postgresql.core.ParameterList.getValues. Returns the bound parameter values.
pack-priv boolean	hasUnresolvedTypes()
pack-priv boolean	isBinary(@Positive int index)
pack-priv boolean	isNull(@Positive int index)
private static String	quoteAndCast(String text, @Nullable String type, boolean standardConformingStrings) Escapes a given text value as a literal, wraps it in single quotes, casts it to the to the given data type, and finally wraps the whole thing in parentheses.
public void	registerOutParameter(int index, int sqlType)
public void	setBinaryParameter(@Positive int index, byte[] value, int oid)
public void	setBytea(@Positive int index, byte[] data, int offset, @NonNegative int length)
public void	setBytea(@Positive int index, InputStream stream, @NonNegative int length)
public void	setBytea(@Positive int index, InputStream stream)
public void	setBytea(@Positive int index, ByteStreamWriter writer)
public void	setIntParameter(@Positive int index, int value)
public void	setLiteralParameter(@Positive int index, String value, int oid)
public void	setNull(@Positive int index, int oid)
pack-priv void	setResolvedType(@Positive int index, int oid)
public void	setStringParameter(@Positive int index, String value, int oid)
public void	setText(@Positive int index, InputStream stream)
private static void	streamBytea(PGStream pgStream, StreamWrapper wrapper)
private static void	streamBytea(PGStream pgStream, ByteStreamWriter writer)
public String	toString(@Positive int index, boolean standardConformingStrings)
public String	Returns: String representation of the list values toString() Overrides java.lang.Object.toString. Useful implementation of toString.
pack-priv void	writeV3Value(@Positive int index, PGStream pgStream)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

BINARY	back to summary
private static final byte BINARY

encoded	back to summary
private final @Nullable byte[][] encoded

flags	back to summary
private final byte[] flags

IN	back to summary
private static final byte IN

INOUT	back to summary
private static final byte INOUT

NULL_OBJECT	back to summary
private static final Object NULL_OBJECT Marker object representing NULL; this distinguishes "parameter never set" from "parameter set to null".

OUT	back to summary
private static final byte OUT

paramTypes	back to summary
private final int[] paramTypes

paramValues	back to summary
private final @Nullable Object[] paramValues

pos	back to summary
private int pos

TEXT	back to summary
private static final byte TEXT

transferModeRegistry	back to summary
private final @Nullable TypeTransferModeRegistry transferModeRegistry

SimpleParameterList	back to summary
pack-priv SimpleParameterList(int paramCount, @Nullable TypeTransferModeRegistry transferModeRegistry)

Method Detail

appendAll	back to summary
public void appendAll(ParameterList list) throws SQLException Implements org.postgresql.core.ParameterList.appendAll. Doc from org.postgresql.core.ParameterList.appendAll. Use this operation to append more parameters to the current list. Parameters list:ParameterList of parameters to append with. Annotations @Override Exceptions SQLException: fault raised if driver or back end throw an exception

appendAll

back to summary

public void appendAll(ParameterList list) throws SQLException

Implements org.postgresql.core.ParameterList.appendAll.

Doc from org.postgresql.core.ParameterList.appendAll.

Use this operation to append more parameters to the current list.

Parameters

list:ParameterList: of parameters to append with.

Annotations

@Override

Exceptions

SQLException:: fault raised if driver or back end throw an exception

bind	back to summary
private void bind(int index, Object value, int oid, byte binary) throws SQLException

checkAllParametersSet	back to summary
public void checkAllParametersSet() throws SQLException Implements org.postgresql.core.v3.V3ParameterList.checkAllParametersSet. Doc from org.postgresql.core.v3.V3ParameterList.checkAllParametersSet. Ensure that all parameters in this list have been assigned values. Return silently if all is well, otherwise throw an appropriate exception. Annotations @Override Exceptions SQLException: if not all parameters are set.

checkAllParametersSet

back to summary

public void checkAllParametersSet() throws SQLException

Implements org.postgresql.core.v3.V3ParameterList.checkAllParametersSet.

Doc from org.postgresql.core.v3.V3ParameterList.checkAllParametersSet.

Ensure that all parameters in this list have been assigned values. Return silently if all is well, otherwise throw an appropriate exception.

Annotations

@Override

Exceptions

SQLException:: if not all parameters are set.

clear	back to summary
public void clear() Implements org.postgresql.core.ParameterList.clear. Doc from org.postgresql.core.ParameterList.clear. Unbind all parameter values bound in this list. Annotations @Override

clear

back to summary

public void clear()

Implements org.postgresql.core.ParameterList.clear.

Doc from org.postgresql.core.ParameterList.clear.

Unbind all parameter values bound in this list.

Annotations

@Override

convertFunctionOutParameters	back to summary
public void convertFunctionOutParameters() Implements org.postgresql.core.v3.V3ParameterList.convertFunctionOutParameters. Doc from org.postgresql.core.v3.V3ParameterList.convertFunctionOutParameters. Convert any function output parameters to the correct type (void) and set an ignorable value for it. Annotations @Override

convertFunctionOutParameters

back to summary

public void convertFunctionOutParameters()

Implements org.postgresql.core.v3.V3ParameterList.convertFunctionOutParameters.

Doc from org.postgresql.core.v3.V3ParameterList.convertFunctionOutParameters.

Convert any function output parameters to the correct type (void) and set an ignorable value for it.

Annotations

@Override

copy	back to summary
public ParameterList copy() Implements org.postgresql.core.ParameterList.copy. Doc from org.postgresql.core.ParameterList.copy. Perform a shallow copy of this ParameterList, returning a new instance (still suitable for passing to the owning Query). If this ParameterList is immutable, copy() may return the same immutable object. Returns:ParameterList a new ParameterList instance Annotations @Override

copy

back to summary

public ParameterList copy()

Implements org.postgresql.core.ParameterList.copy.

Doc from org.postgresql.core.ParameterList.copy.

Perform a shallow copy of this ParameterList, returning a new instance (still suitable for passing to the owning Query). If this ParameterList is immutable, copy() may return the same immutable object.

Returns:ParameterList

a new ParameterList instance

Annotations

@Override

direction	back to summary
private byte direction(@Positive int index)

getEncoding	back to summary
public @Nullable byte[][] getEncoding() Implements org.postgresql.core.v3.V3ParameterList.getEncoding. Doc from org.postgresql.core.v3.V3ParameterList.getEncoding. Return the encoding for each parameter. Returns:@Nullable byte[][] nested byte array of bytes with encoding information. Annotations @Override

getEncoding

back to summary

public @Nullable byte[][] getEncoding()

Implements org.postgresql.core.v3.V3ParameterList.getEncoding.

Doc from org.postgresql.core.v3.V3ParameterList.getEncoding.

Return the encoding for each parameter.

Returns:@Nullable byte[][]

nested byte array of bytes with encoding information.

Annotations

@Override

getFlags	back to summary
public byte[] getFlags() Implements org.postgresql.core.v3.V3ParameterList.getFlags. Doc from org.postgresql.core.v3.V3ParameterList.getFlags. Return the flags for each parameter. Returns:byte[] an array of bytes used to store flags. Annotations @Override

getFlags

back to summary

public byte[] getFlags()

Implements org.postgresql.core.v3.V3ParameterList.getFlags.

Doc from org.postgresql.core.v3.V3ParameterList.getFlags.

Return the flags for each parameter.

Returns:byte[]

an array of bytes used to store flags.

Annotations

@Override

getInParameterCount	back to summary
public @NonNegative int getInParameterCount() Implements org.postgresql.core.ParameterList.getInParameterCount. Doc from org.postgresql.core.ParameterList.getInParameterCount. Get the number of IN parameters in this list. Returns:@NonNegative int the number of IN parameters in this list Annotations @Override

getInParameterCount

back to summary

public @NonNegative int getInParameterCount()

Implements org.postgresql.core.ParameterList.getInParameterCount.

Doc from org.postgresql.core.ParameterList.getInParameterCount.

Get the number of IN parameters in this list.

Returns:@NonNegative int

the number of IN parameters in this list

Annotations

@Override

getOutParameterCount	back to summary
public @NonNegative int getOutParameterCount() Implements org.postgresql.core.ParameterList.getOutParameterCount. Doc from org.postgresql.core.ParameterList.getOutParameterCount. Get the number of OUT parameters in this list. Returns:@NonNegative int the number of OUT parameters in this list Annotations @Override

getOutParameterCount

back to summary

public @NonNegative int getOutParameterCount()

Implements org.postgresql.core.ParameterList.getOutParameterCount.

Doc from org.postgresql.core.ParameterList.getOutParameterCount.

Get the number of OUT parameters in this list.

Returns:@NonNegative int

the number of OUT parameters in this list

Annotations

@Override

getParameterCount	back to summary
public @NonNegative int getParameterCount() Implements org.postgresql.core.ParameterList.getParameterCount. Doc from org.postgresql.core.ParameterList.getParameterCount. Get the number of parameters in this list. This value never changes for a particular instance, and might be zero. Returns:@NonNegative int the number of parameters in this list. Annotations @Override

getParameterCount

back to summary

public @NonNegative int getParameterCount()

Implements org.postgresql.core.ParameterList.getParameterCount.

Doc from org.postgresql.core.ParameterList.getParameterCount.

Get the number of parameters in this list. This value never changes for a particular instance, and might be zero.

Returns:@NonNegative int

the number of parameters in this list.

Annotations

@Override

getParamTypes back to summary

getParamTypes	back to summary
public int[] getParamTypes() Implements org.postgresql.core.v3.V3ParameterList.getParamTypes. Doc from org.postgresql.core.v3.V3ParameterList.getParamTypes. Return the parameter type information. Returns:int[] an array of `org.postgresql.core.Oid` type information Annotations @Override

public int[] getParamTypes()

Implements org.postgresql.core.v3.V3ParameterList.getParamTypes.

Doc from org.postgresql.core.v3.V3ParameterList.getParamTypes.

Return the parameter type information.

Returns:int[]

an array of org.postgresql.core.Oid type information

Annotations

@Override

getSubparams back to summary

getSubparams	back to summary
public @Nullable SimpleParameterList[] getSubparams() Implements org.postgresql.core.v3.V3ParameterList.getSubparams. Doc from org.postgresql.core.v3.V3ParameterList.getSubparams. Return a list of the SimpleParameterList objects that make up this parameter list. If this object is already a SimpleParameterList, returns null (avoids an extra array construction in the common case). Returns:@Nullable SimpleParameterList[] an array of single-statement parameter lists, or `null` if this object is already a single-statement parameter list. Annotations @Override

public @Nullable SimpleParameterList[] getSubparams()

Implements org.postgresql.core.v3.V3ParameterList.getSubparams.

Doc from org.postgresql.core.v3.V3ParameterList.getSubparams.

Return a list of the SimpleParameterList objects that make up this parameter list. If this object is already a SimpleParameterList, returns null (avoids an extra array construction in the common case).

Returns:@Nullable SimpleParameterList[]

an array of single-statement parameter lists, or null if this object is already a single-statement parameter list.

Annotations

@Override

getTypeOID	back to summary
pack-priv int getTypeOID(@Positive int index)

getTypeOIDs	back to summary
public int[] getTypeOIDs() Implements org.postgresql.core.ParameterList.getTypeOIDs. Doc from org.postgresql.core.ParameterList.getTypeOIDs. Return the oids of the parameters in this list. May be null for a ParameterList that does not support typing of parameters. Returns:int[] oids of the parameters Annotations @Override

getTypeOIDs

back to summary

public int[] getTypeOIDs()

Implements org.postgresql.core.ParameterList.getTypeOIDs.

Doc from org.postgresql.core.ParameterList.getTypeOIDs.

Return the oids of the parameters in this list. May be null for a ParameterList that does not support typing of parameters.

Returns:int[]

oids of the parameters

Annotations

@Override

getV3Length	back to summary
pack-priv int getV3Length(@Positive int index)

getValues	back to summary
public @Nullable Object[] getValues() Implements org.postgresql.core.ParameterList.getValues. Doc from org.postgresql.core.ParameterList.getValues. Returns the bound parameter values. Returns:@Nullable Object[] Object array containing the parameter values. Annotations @Override

getValues

back to summary

public @Nullable Object[] getValues()

Implements org.postgresql.core.ParameterList.getValues.

Doc from org.postgresql.core.ParameterList.getValues.

Returns the bound parameter values.

Returns:@Nullable Object[]

Object array containing the parameter values.

Annotations

@Override

hasUnresolvedTypes	back to summary
pack-priv boolean hasUnresolvedTypes()

isBinary	back to summary
pack-priv boolean isBinary(@Positive int index)

isNull	back to summary
pack-priv boolean isNull(@Positive int index)

quoteAndCast back to summary

quoteAndCast	back to summary
private static String quoteAndCast(String text, @Nullable String type, boolean standardConformingStrings) Escapes a given text value as a literal, wraps it in single quotes, casts it to the to the given data type, and finally wraps the whole thing in parentheses. For example, "123" and "int4" becomes "('123'::int)" The additional parentheses is added to ensure that the surrounding text of where the parameter value is entered does modify the interpretation of the value. For example if our input SQL is: `SELECT ?b` Using a parameter value of '{}' and type of json we'd get: test=# SELECT ('{}'::json)b; b ---- {} But without the parentheses the result changes: test=# SELECT '{}'::jsonb; jsonb ------- {}

private static String quoteAndCast(String text, @Nullable String type, boolean standardConformingStrings)

Escapes a given text value as a literal, wraps it in single quotes, casts it to the to the given data type, and finally wraps the whole thing in parentheses.

For example, "123" and "int4" becomes "('123'::int)"

The additional parentheses is added to ensure that the surrounding text of where the parameter value is entered does modify the interpretation of the value.

For example if our input SQL is: SELECT ?b

Using a parameter value of '{}' and type of json we'd get:

test=# SELECT ('{}'::json)b;
 b
----
 {}

But without the parentheses the result changes:

test=# SELECT '{}'::jsonb;
jsonb
-------
{}

registerOutParameter	back to summary
public void registerOutParameter(int index, int sqlType) throws SQLException Annotations @Override

setBinaryParameter	back to summary
public void setBinaryParameter(@Positive int index, byte[] value, int oid) throws SQLException Annotations @Override

setBytea	back to summary
public void setBytea(@Positive int index, byte[] data, int offset, @NonNegative int length) throws SQLException Annotations @Override

setBytea	back to summary
public void setBytea(@Positive int index, InputStream stream, @NonNegative int length) throws SQLException Annotations @Override

setBytea	back to summary
public void setBytea(@Positive int index, InputStream stream) throws SQLException Annotations @Override

setBytea	back to summary
public void setBytea(@Positive int index, ByteStreamWriter writer) throws SQLException Annotations @Override

setIntParameter	back to summary
public void setIntParameter(@Positive int index, int value) throws SQLException Annotations @Override

setLiteralParameter	back to summary
public void setLiteralParameter(@Positive int index, String value, int oid) throws SQLException Annotations @Override

setNull	back to summary
public void setNull(@Positive int index, int oid) throws SQLException Annotations @Override

setResolvedType	back to summary
pack-priv void setResolvedType(@Positive int index, int oid)

setStringParameter	back to summary
public void setStringParameter(@Positive int index, String value, int oid) throws SQLException Annotations @Override

setText	back to summary
public void setText(@Positive int index, InputStream stream) throws SQLException Annotations @Override

streamBytea	back to summary
private static void streamBytea(PGStream pgStream, StreamWrapper wrapper) throws IOException

streamBytea	back to summary
private static void streamBytea(PGStream pgStream, ByteStreamWriter writer) throws IOException

toString	back to summary
public String toString(@Positive int index, boolean standardConformingStrings) Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Useful implementation of toString.

Returns:String

String representation of the list values

Annotations

@Override

writeV3Value	back to summary
pack-priv void writeV3Value(@Positive int index, PGStream pgStream) throws IOException

pack-priv Class SimpleParameterList

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail