oracle.dss.util

Class Parameter

java.lang.Object

oracle.dss.util.Parameter

All Implemented Interfaces:

java.io.Serializable

public class Parameter
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

For internal use only. Application developers should not use this

Describes a single parameter of an API method which includes an Object value and its associated Class type. Note that all values stored in this structure must be serializable. Primitive parameter types are converted their associated Object type. For example, a primitive boolean is stored as a Boolean object: Parameter parameter = new Parameter (new Boolean (boolean), Boolean.class); If the Parameter value is later referenced, the primitive value can be extracted similar to the following example: if (parameter.getType() == Boolean.class) ((Boolean)parameter.getValue()).booleanValue();

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class	m_classType Parameter Class of Object.
protected java.lang.Object	m_objValue Parameter Object value.

Constructor Summary

Constructors

Constructor and Description
Parameter() Default constructor.
Parameter(boolean bValue) Constructs a Parameter from the specified boolean value.
Parameter(double dValue) Constructs a Parameter from the specified double value.
Parameter(float fValue) Constructs a Parameter from the specified float value.
Parameter(int nValue) Constructs a Parameter from the specified int value.
Parameter(long lValue) Constructs a Parameter from the specified long value.
Parameter(java.lang.Object objValue) Constructs a Parameter from the specified Object value.
Parameter(java.lang.Object objValue, java.lang.Class classValue) Construct a Parameter based the the specified value and class.
Parameter(java.lang.String strValue) Constructs a Parameter from the specified String value.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clones a copy of this Parameter object.
boolean	equals(java.lang.Object objValue) Tests this Parameter for true equality
java.lang.Class	getType() Return the Class type.
java.lang.Object	getValue() Return the Object value.
void	setType(java.lang.Class classType) Specifies the Class type associated with the Parameter.
void	setValue(java.lang.Object objValue) Specifies the Object value associated with the Parameter.
java.lang.String	toString() Retrieves the String representation of the Parameter.

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_objValue

protected java.lang.Object m_objValue

Parameter Object value.

m_classType

protected java.lang.Class m_classType

Parameter Class of Object.

Constructor Detail

Parameter

public Parameter()

Default constructor.

Parameter

public Parameter(java.lang.Object objValue,
                 java.lang.Class classValue)

Construct a Parameter based the the specified value and class.

Parameters:

objValue - a Object value to create Parameter.

classValue - a Class value associated with the object.

Parameter

public Parameter(java.lang.Object objValue)

Constructs a Parameter from the specified Object value.

Parameters:

objValue - a Object value to retrieve Parameter for.

Parameter

public Parameter(java.lang.String strValue)

Constructs a Parameter from the specified String value.

Parameters:

strValue - a String value used to create Parameter.

Parameter

public Parameter(int nValue)

Constructs a Parameter from the specified int value.

Parameters:

nValue - a int value used to create Parameter

Parameter

public Parameter(float fValue)

Constructs a Parameter from the specified float value.

Parameters:

fValue - a float value used to create Parameter

Parameter

public Parameter(long lValue)

Constructs a Parameter from the specified long value.

Parameters:

lValue - a long value used to create Parameter

Parameter

public Parameter(double dValue)

Constructs a Parameter from the specified double value.

Parameters:

dValue - a int value used to create Parameter

Parameter

public Parameter(boolean bValue)

Constructs a Parameter from the specified boolean value.

Parameters:

bValue - a int value used to create Parameter

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clones a copy of this Parameter object.

Overrides:

clone in class java.lang.Object

Returns:

Object which represents a clone of this parameter.

Throws:

CloneNotSupportedException - if cloning is not supported

java.lang.CloneNotSupportedException

equals

public boolean equals(java.lang.Object objValue)

Tests this Parameter for true equality

Overrides:

equals in class java.lang.Object

Parameters:

objValue - a Object value to compare this Parameter to.

Returns:

boolean which is true when the objects are internally equal and false otherwise.

getType

public java.lang.Class getType()

Return the Class type.

Returns:

Class which represents the class of the Parameter.

getValue

public java.lang.Object getValue()

Return the Object value.

Returns:

Object which represents the value of the Parameter.

setValue

public void setValue(java.lang.Object objValue)

Specifies the Object value associated with the Parameter.

Parameters:

objValue - a Object value associated with the Parameter.

setType

public void setType(java.lang.Class classType)

Specifies the Class type associated with the Parameter.

Parameters:

classType - a Class type associated with the Parameter.

toString

public java.lang.String toString()

Retrieves the String representation of the Parameter.

Overrides:

toString in class java.lang.Object