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:

  • Constructor Details

  • Method Details

    • 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

    • 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