com.avaje.ebeaninternal.api

Class BindParams.Param

java.lang.Object

com.avaje.ebeaninternal.api.BindParams.Param

All Implemented Interfaces:

Serializable

Enclosing class:

BindParams

public static final class BindParams.Param
extends Object
implements Serializable

A In Out capable parameter for the CallableStatement.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BindParams.Param() Construct a Parameter.

Method Summary

Methods

Modifier and Type	Method and Description
BindParams.Param	copy() Create a deep copy of the Param.
boolean	equals(Object o)
Object	getInValue() Return the In value.
Object	getOutValue() Return the OUT value that was retrieved.
int	getTextLocation() Return the location this parameter was found in the sql text.
int	getType() Return the jdbc type of this parameter.
int	hashCode()
boolean	isEncryptionKey() If true do not include this value in a transaction log.
boolean	isInParam() Return true if this is an In parameter that needs to be bound before execution.
boolean	isOutParam() Return true if this is an out parameter that needs to be registered before execution.
int	queryBindCount()
void	setEncryptionKey(Object in) Set an encryption key (which can not be logged).
void	setInNullType(int type) Specify that the In parameter is NULL and the specific type that it is.
void	setInValue(Object in) Set the In value.
void	setOutType(int type) Set the Out parameter type.
void	setOutValue(Object out) Set the OUT value returned by a CallableStatement after it has executed.
void	setTextLocation(int textLocation) Set the location in the sql text this parameter was located.

Methods inherited from class java.lang.Object

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

Constructor Detail

BindParams.Param

public BindParams.Param()

Construct a Parameter.

Method Detail

queryBindCount

public int queryBindCount()

copy

public BindParams.Param copy()

Create a deep copy of the Param.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

isInParam

public boolean isInParam()

Return true if this is an In parameter that needs to be bound before execution.

isOutParam

public boolean isOutParam()

Return true if this is an out parameter that needs to be registered before execution.

getType

public int getType()

Return the jdbc type of this parameter. Used for registering Out parameters and setting NULL In parameters.

setOutType

public void setOutType(int type)

Set the Out parameter type.

setInValue

public void setInValue(Object in)

Set the In value.

setEncryptionKey

public void setEncryptionKey(Object in)

Set an encryption key (which can not be logged).

setInNullType

public void setInNullType(int type)

Specify that the In parameter is NULL and the specific type that it is.

getOutValue

public Object getOutValue()

Return the OUT value that was retrieved. This value is set after CallableStatement was executed.

getInValue

public Object getInValue()

Return the In value. If this is null, then the type should be used to specify the type of the null.

setOutValue

public void setOutValue(Object out)

Set the OUT value returned by a CallableStatement after it has executed.

getTextLocation

public int getTextLocation()

Return the location this parameter was found in the sql text.

setTextLocation

public void setTextLocation(int textLocation)

Set the location in the sql text this parameter was located. This is used to control order for named parameters.

isEncryptionKey

public boolean isEncryptionKey()

If true do not include this value in a transaction log.