Top Description Methods
org.postgresql.core.v3

pack-priv Interface V3ParameterList

extends ParameterList
Known Direct Implementers
org.postgresql.core.v3.CompositeParameterList, org.postgresql.core.v3.SimpleParameterList
Imports
org.postgresql.core.ParameterList, org.checkerframework.checker.nullness.qual.Nullable, java.sql.SQLException

Common interface for all V3 parameter list implementations.
Author
Oliver Jowett ([email protected])

Method Summary

Modifier and TypeMethod and Description
public void
checkAllParametersSet()

Ensure that all parameters in this list have been assigned values.

public void
convertFunctionOutParameters()

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

public @Nullable @Nullable byte[][]

Returns:

nested byte array of bytes with encoding information.
getEncoding
()

Return the encoding for each parameter.

public @Nullable byte[]

Returns:

an array of bytes used to store flags.
getFlags
()

Return the flags for each parameter.

public @Nullable int[]

Returns:

an array of org.postgresql.core.Oid type information
getParamTypes
()

Return the parameter type information.

public @Nullable SimpleParameterList[]

Returns:

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

Return a list of the SimpleParameterList objects that make up this parameter list.

Inherited from org.postgresql.core.ParameterList:
appendAllclearcopygetInParameterCountgetOutParameterCountgetParameterCountgetTypeOIDsgetValuesregisterOutParametersetBinaryParametersetByteasetByteasetByteasetByteasetIntParametersetLiteralParametersetNullsetStringParametersetTexttoString

Method Detail

checkAllParametersSetback to summary
public void checkAllParametersSet() throws SQLException

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

Exceptions
SQLException:
if not all parameters are set.
convertFunctionOutParametersback to summary
public void convertFunctionOutParameters()

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

getEncodingback to summary
public @Nullable @Nullable byte[][] getEncoding()

Return the encoding for each parameter.

Returns:@Nullable @Nullable byte[][]

nested byte array of bytes with encoding information.

getFlagsback to summary
public @Nullable byte[] getFlags()

Return the flags for each parameter.

Returns:@Nullable byte[]

an array of bytes used to store flags.

getParamTypesback to summary
public @Nullable int[] getParamTypes()

Return the parameter type information.

Returns:@Nullable int[]

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

getSubparamsback to summary
public @Nullable SimpleParameterList[] 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.