Package com.tangosol.config.expression

Class Parameter

java.lang.Object

com.tangosol.config.expression.Parameter

All Implemented Interfaces:

Expression<Value>, ExternalizableLite, PortableObject, Serializable

public class Parameter
extends Object
implements Expression<Value>, ExternalizableLite, PortableObject

A Parameter represents an optionally named and optionally explicitly typed Expression.

Terminology:

A Parameter that doesn't have a name, or when the name is irrelevant, is referred to as an Actual Parameter. That is, only the value of the Parameter is of any importance.

A Parameter with a name and/or when the name is of importance, is referred to as a Formal Parameter or Argument.

NOTE: This class is used to represent Actual and Formal Parameters.

Since:

Coherence 12.1.2

Author:

bo 2011.06.22

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Parameter()	Default constructor needed for serialization.
Parameter(String sName, Expression<?> expression)	Construct an implicitly typed Parameter based on an Expression.
Parameter(String sName, Class<?> clzType, Expression<?> expression)	Construct an Parameter.
Parameter(String sName, Class<?> clzType, Object oValue)	Construct an explicitly typed Object-based Parameter.
Parameter(String sName, Object oValue)	Construct an implicitly typed Object-based Parameter.

Method Summary

Modifier and Type	Method	Description
Value	evaluate(ParameterResolver resolver)	Evaluates the Expression to produce a value of type T.
Class<?>	getExplicitType()	Obtains the explicitly specified type of the Parameter.
Expression<?>	getExpression()	Obtains the Expression for the Parameter.
String	getName()	Obtains the name of the Parameter.
boolean	isExplicitlyTyped()	Obtains if an expected/actual type of the Parameter has been specified/is known.
void	readExternal(PofReader reader)	Restore the contents of a user type instance by reading its state using the specified PofReader object.
void	readExternal(DataInput in)	Restore the contents of this object by loading the object's state from the passed DataInput object.
String	toString()
void	writeExternal(PofWriter writer)	Save the contents of a POF user type instance by writing its state using the specified PofWriter object.
void	writeExternal(DataOutput out)	Save the contents of this object by storing the object's state into the passed DataOutput object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Parameter

public Parameter()

Default constructor needed for serialization.

Parameter

public Parameter(String sName,
                 Expression<?> expression)

Construct an implicitly typed Parameter based on an Expression.

Parameters:

sName - the name of the Parameter

expression - the Expression for the Parameter

Parameter

public Parameter(String sName,
                 Object oValue)

Construct an implicitly typed Object-based Parameter.

Parameters:

sName - the name of the Parameter

oValue - the value for the Parameter

Parameter

public Parameter(String sName,
                 Class<?> clzType,
                 Expression<?> expression)

Construct an Parameter.

Parameters:

sName - the name of the Parameter

clzType - the expected type of the Parameter

expression - the Expression for the Parameter

Parameter

public Parameter(String sName,
                 Class<?> clzType,
                 Object oValue)

Construct an explicitly typed Object-based Parameter.

Parameters:

sName - the name of the Parameter

clzType - the expected type of the Parameter

oValue - the value for the Parameter

Method Detail

evaluate

public Value evaluate(ParameterResolver resolver)

Evaluates the Expression to produce a value of type T.

Specified by:

evaluate in interface Expression<Value>

Parameters:

resolver - the ParameterResolver for resolving any parameters used by the Expression

Returns:

The result of evaluating the expression

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

Obtains the name of the Parameter.

Returns:

a String representing the name of the Parameter

getExplicitType

public Class<?> getExplicitType()

Obtains the explicitly specified type of the Parameter.

Returns:

a Class representing the type of the Parameter

isExplicitlyTyped

public boolean isExplicitlyTyped()

Obtains if an expected/actual type of the Parameter has been specified/is known.

Returns:

true if the type of the Parameter is known/specified. ie: getExplicitType() is not null, otherwise returns false.

getExpression

public Expression<?> getExpression()

Obtains the Expression for the Parameter.

Returns:

the Expression for the Parameter

readExternal

public void readExternal(DataInput in)
                  throws IOException

Restore the contents of this object by loading the object's state from the passed DataInput object.

Specified by:

readExternal in interface ExternalizableLite

Parameters:

in - the DataInput stream to read data from in order to restore the state of this object

Throws:

IOException - if an I/O exception occurs

NotActiveException - if the object is not in its initial state, and therefore cannot be deserialized into

writeExternal

public void writeExternal(DataOutput out)
                   throws IOException

Save the contents of this object by storing the object's state into the passed DataOutput object.

Specified by:

writeExternal in interface ExternalizableLite

Parameters:

out - the DataOutput stream to write the state of this object to

Throws:

IOException - if an I/O exception occurs

readExternal

public void readExternal(PofReader reader)
                  throws IOException

Restore the contents of a user type instance by reading its state using the specified PofReader object.

Specified by:

readExternal in interface PortableObject

Parameters:

reader - the PofReader from which to read the object's state

Throws:

IOException - if an I/O error occurs

writeExternal

public void writeExternal(PofWriter writer)
                   throws IOException

Save the contents of a POF user type instance by writing its state using the specified PofWriter object.

Specified by:

writeExternal in interface PortableObject

Parameters:

writer - the PofWriter to which to write the object's state

Throws:

IOException - if an I/O error occurs