java.io.Externalizable
, java.io.Serializable
, java.lang.Cloneable
public final class ParamValue
extends java.lang.Object
implements java.lang.Cloneable, java.io.Externalizable
A ParamValue may be made up of a vector of ParamValues, in which case the elements in the vector are accessible by index position.
The variables in this class are used for setting attributes for IN, OUT and IN/OUT parameters used for database stored procedures.
Conversions among the various datatypes are handled automatically in a "Java" way, i.e., the conversion can be accomplished either of these ways:
float f = 1.2; int i = (int) f;
boolean b = Boolean.booleanValue("t");
Modifier and Type | Field | Description |
---|---|---|
protected java.lang.String |
paramDesc |
Variable used for IN, OUT, and IN/OUT parameters
to set the descriptor of the parameter.
|
protected int |
paramMode |
Variable used for IN, OUT, and IN/OUT parameters to
set the mode of the parameter.
|
protected java.lang.String |
paramName |
Variable used for IN, OUT, and IN/OUT parameters
to set the name of the parameter.
|
protected int |
paramType |
Variable used for IN, OUT, and IN/OUT parameters to
set the type of the parameter.
|
Modifier and Type | Method | Description |
---|---|---|
boolean |
asBoolean() |
Returns a ParamValue as a
boolean.
|
byte |
asByte() |
Returns a ParamValue as a
byte.
|
char |
asChar() |
Returns a ParamValue as a
char.
|
java.util.Date |
asDate() |
Returns a ParamValue as a
Date.
|
double |
asDouble() |
Returns a ParamValue as a
double.
|
float |
asFloat() |
Returns a ParamValue as a
float.
|
int |
asInt() |
Returns a ParamValue as a
int.
|
long |
asLong() |
Returns a ParamValue as a
long.
|
java.lang.Object |
asObject() |
Returns a ParamValue as an
Object.
|
short |
asShort() |
Returns a ParamValue as a
short.
|
java.lang.String |
asString() |
Returns a ParamValue as a
String.
|
java.lang.Object |
clone() |
Clones a ParamValue.
|
void |
destroy() |
Destroys a ParamValue object.
|
java.lang.String |
dump() |
Returns a formatted string representation of a ParamValue.
|
ParamValue |
elementAt(int index) |
Used for accessing ParamValues in a Vector of
ParamValues.
|
void |
initialize() |
Initializes a ParamValue.
|
boolean |
isBoolean() |
Determines whether a ParamValue is of type
boolean.
|
boolean |
isByte() |
Determines whether a ParamValue is of type
byte.
|
boolean |
isChar() |
Determines whether a ParamValue is of type
char.
|
boolean |
isDate() |
Determines whether a ParamValue is of type
Date.
|
boolean |
isDouble() |
Determines whether a ParamValue is of type
double.
|
boolean |
isFloat() |
Determines whether a ParamValue is of type
float.
|
boolean |
isInt() |
Determines whether a ParamValue is of type
int.
|
boolean |
isLong() |
Determines whether a ParamValue is of type
long.
|
boolean |
isNull() |
Determines whether a ParamValue is null.
|
boolean |
isNull(int index) |
Determines whether a ParamValue that is a vector of
ParamValues is null at the
specified index position.
|
boolean |
isObject() |
Determines whether a ParamValue is of type
Object.
|
boolean |
isScalar() |
Determines whether a ParamValue is scalar.
|
boolean |
isShort() |
Determines whether a ParamValue is of type
short.
|
boolean |
isString() |
Determines whether a ParamValue is of type
String.
|
boolean |
isVector() |
Determines whether a ParamValue is a Vector.
|
java.lang.String |
name() |
Returns the paramName of a ParamValue.
|
java.lang.String |
paramDesc() |
Returns the paramDesc of a ParamValue.
|
int |
paramMode() |
Returns the paramMode of a ParamValue.
|
java.lang.String |
paramModeString() |
Returns the paramMode of a ParamValue as a String.
|
int |
paramType() |
Returns the paramType of a ParamValue.
|
java.lang.String |
paramTypeString() |
Returns the paramType of a ParamValue as a String.
|
void |
readExternal(java.io.ObjectInput oi) |
Constructs a ParamValue from the specified serialization stream
|
ParamValue |
set(boolean val) |
Sets the value of a ParamValue to a
boolean.
|
ParamValue |
set(boolean val,
int index) |
Sets the value at the specified index into a Vector
of ParamValues to the specified boolean.
|
ParamValue |
set(byte val) |
Sets the value of a ParamValue to a
byte.
|
ParamValue |
set(char val) |
Sets the value of a ParamValue to a
char.
|
ParamValue |
set(char val,
int index) |
Sets the value at the specified index into a Vector
of ParamValues to the specified char.
|
ParamValue |
set(double val) |
Sets the value of a ParamValue to a
double.
|
ParamValue |
set(double val,
int index) |
Sets the value at the specified index into a Vector
of ParamValues to the specified double.
|
ParamValue |
set(float val) |
Sets the value of a ParamValue to a
float.
|
ParamValue |
set(float val,
int index) |
Sets the value at the specified index into a Vector
of ParamValues to the specified float.
|
ParamValue |
set(int val) |
Sets the value of a ParamValue to an
int.
|
ParamValue |
set(int val,
int index) |
Sets the value at the specified index into a Vector
of ParamValues to the specified int.
|
ParamValue |
set(long val) |
Sets the value of a ParamValue to a
long.
|
ParamValue |
set(long val,
int index) |
Sets the value at the specified index into a Vector
of ParamValues to the specified long.
|
ParamValue |
set(short val) |
Sets the value of a ParamValue to a
short.
|
ParamValue |
set(short val,
int index) |
Sets the value at the specified index into a Vector
of ParamValues to the specified integer.
|
ParamValue |
set(java.lang.Object val) |
Sets the value of a ParamValue to an Object.
|
ParamValue |
set(java.lang.Object val,
int index) |
Sets the value at the specified index into a Vector
of ParamValues to the specified Object.
|
ParamValue |
set(java.lang.String val) |
Sets the value of a ParamValue to a
String.
|
ParamValue |
set(java.lang.String val,
int index) |
Sets the value at the specified index into a Vector
of ParamValues to the specified string.
|
ParamValue |
set(java.util.Date val) |
Sets the value of a ParamValue to a
Date.
|
ParamValue |
set(java.util.Date val,
int index) |
Sets the value at the specified index into a Vector
of ParamValues to the specified date.
|
ParamValue |
set(ParamValue val) |
Sets the value of a ParamValue to a ParamValue.
|
ParamValue |
set(ParamValue val,
int index) |
Sets the value at the specified index into a Vector
of ParamValues to the specified ParamValue.
|
void |
setElementAt(java.lang.Object value,
int index) |
Sets the element at the specified index into
Vector of ParamValues to the specified value.
|
int |
size() |
Returns the size of a Vector of ParamValues.
|
java.lang.String |
toString() |
Returns a string representation of a ParamValue.
|
void |
writeExternal(java.io.ObjectOutput oo) |
Writes a ParamValue object to a serialization stream.
|
protected java.lang.String paramName
protected java.lang.String paramDesc
protected int paramType
protected int paramMode
public void initialize()
public void destroy()
public java.lang.Object clone()
clone
in class java.lang.Object
public void readExternal(java.io.ObjectInput oi) throws java.io.IOException
readExternal
in interface java.io.Externalizable
oi
- WLObjectInputjava.io.IOException
- if there is an IO errorpublic void writeExternal(java.io.ObjectOutput oo) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
java.io.IOException
public java.lang.String name()
public java.lang.String paramDesc()
public int paramType()
public java.lang.String paramTypeString()
public java.lang.String paramModeString()
public boolean isNull(int index) throws ParamSetException
index
- Index into the vector of a ParamValueParamSetException
- if there is an errorpublic boolean isNull()
public int paramMode()
public boolean isScalar()
public boolean isVector()
public boolean isInt()
public boolean isShort()
public boolean isFloat()
public boolean isDouble()
public boolean isDate()
public boolean isString()
public boolean isChar()
public boolean isBoolean()
public boolean isByte()
public boolean isLong()
public boolean isObject()
public ParamValue elementAt(int index) throws ParamSetException
index
- Index positionParamSetException
- if there is an errorpublic void setElementAt(java.lang.Object value, int index) throws ParamSetException
value
- Valueindex
- Index positionParamSetException
- if the value cannot be setpublic int size() throws ParamSetException
ParamSetException
- if there is an errorpublic ParamValue set(ParamValue val, int index) throws ParamSetException
val
- Value of type ParamValueindex
- Index into a Vector of ParamValuesParamSetException
- if the value cannot be setpublic ParamValue set(boolean val, int index) throws ParamSetException
val
- boolean valueindex
- Index into a Vector of ParamValuesParamSetException
- if the value cannot be setpublic ParamValue set(short val, int index) throws ParamSetException
val
- shortindex
- Index into a Vector of ParamValuesParamSetException
- if the value cannot be setpublic ParamValue set(int val, int index) throws ParamSetException
val
- intindex
- Index into a Vector of ParamValuesParamSetException
- if the value cannot be setpublic ParamValue set(long val, int index) throws ParamSetException
val
- longindex
- Index into a Vector of ParamValuesParamSetException
- if the value cannot be setpublic ParamValue set(double val, int index) throws ParamSetException
val
- doubleindex
- Index into a Vector of ParamValuesParamSetException
- if the value cannot be setpublic ParamValue set(float val, int index) throws ParamSetException
val
- floatindex
- Index into a Vector of ParamValuesParamSetException
- if the value cannot be setpublic ParamValue set(char val, int index) throws ParamSetException
val
- charindex
- Index into a Vector of ParamValuesParamSetException
- if the value cannot be setpublic ParamValue set(java.lang.String val, int index) throws ParamSetException
val
- Stringindex
- Index into a Vector of ParamValuesParamSetException
- if the value cannot be setpublic ParamValue set(java.util.Date val, int index) throws ParamSetException
val
- Dateindex
- Index into a Vector of ParamValuesParamSetException
- if the value cannot be setpublic ParamValue set(java.lang.Object val, int index) throws ParamSetException
val
- Objectindex
- Index into a Vector of ParamValuesParamSetException
- if the value cannot be setpublic ParamValue set(ParamValue val) throws ParamSetException
val
- ParamValueParamSetException
- if the value cannot be setpublic ParamValue set(boolean val) throws ParamSetException
val
- booleanParamSetException
- if the value cannot be setpublic ParamValue set(int val) throws ParamSetException
val
- intParamSetException
- if the value cannot be setpublic ParamValue set(short val) throws ParamSetException
val
- shortParamSetException
- if the value cannot be setpublic ParamValue set(byte val) throws ParamSetException
val
- byteParamSetException
- if the value cannot be setpublic ParamValue set(long val) throws ParamSetException
val
- longParamSetException
- if the value cannot be setpublic ParamValue set(double val) throws ParamSetException
val
- doubleParamSetException
- if the value cannot be setpublic ParamValue set(float val) throws ParamSetException
val
- floatParamSetException
- if the value cannot be setpublic ParamValue set(char val) throws ParamSetException
val
- charParamSetException
- if the value cannot be setpublic ParamValue set(java.lang.String val) throws ParamSetException
val
- StringParamSetException
- if the value cannot be setpublic ParamValue set(java.util.Date val) throws ParamSetException
val
- DateParamSetException
- if the value cannot be setpublic ParamValue set(java.lang.Object val) throws ParamSetException
val
- ObjectParamSetException
- if the value cannot be setpublic boolean asBoolean() throws ParamSetException
ParamSetException
- if there is a conversion errorpublic byte asByte() throws ParamSetException
ParamSetException
- if there is a conversion errorpublic int asInt() throws ParamSetException
ParamSetException
- if there is a conversion errorpublic short asShort() throws ParamSetException
ParamSetException
- if there is a conversion errorpublic long asLong() throws ParamSetException
ParamSetException
- if there is a conversion errorpublic double asDouble() throws ParamSetException
ParamSetException
- if there is a conversion errorpublic float asFloat() throws ParamSetException
ParamSetException
- if there is a conversion errorpublic char asChar() throws ParamSetException
ParamSetException
- if there is a conversion errorpublic java.lang.String asString() throws ParamSetException
ParamSetException
- if there is a conversion errorpublic java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String dump()
public java.util.Date asDate() throws ParamSetException
ParamSetException
- if there is a conversion errorpublic java.lang.Object asObject() throws ParamSetException
ParamSetException
- if there is a conversion error