Package com.tangosol.util

Class AbstractScript

java.lang.Object
com.tangosol.util.AbstractScript
All Implemented Interfaces:
ExternalizableLite, PortableObject, Serializable
Direct Known Subclasses:
ScriptAggregator, ScriptFilter, ScriptProcessor
public class AbstractScript extends Object implements ExternalizableLite, PortableObject
AbstractScriptBase is the base class for script based processing.
Since:
14.1.1.0
Author:
mk 2019.09.25
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected Object[]
    m_aoArgs
    The arguments to be passed to the script during evaluation.
    protected String
    m_sLanguage
    The language the script is written.
    protected String
    m_sName
    The name of the script object to execute.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractScript()
    Default constructor for ExternalizableLite.
    AbstractScript(String language, String name, Object... args)
    Create a AbstractScriptBase.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object[]
    getArgs()
    Return the arguments to be passed to the script during evaluation.
    String
    getLanguage()
    Return the language the script is written.
    String
    getName()
    Return the name of the script that needs to be evaluated.
    void
    readExternal(PofReader in)
    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.
    void
    writeExternal(PofWriter out)
    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, toString, wait, wait, wait

  • Field Details

    • m_sLanguage

      protected String m_sLanguage
      The language the script is written.

    • m_sName

      protected String m_sName
      The name of the script object to execute.

    • m_aoArgs

      protected Object[] m_aoArgs
      The arguments to be passed to the script during evaluation.

  • Constructor Details

    • AbstractScript

      public AbstractScript()
      Default constructor for ExternalizableLite.

    • AbstractScript

      public AbstractScript(String language, String name, Object... args)
      Create a AbstractScriptBase.
      Parameters:
      language - the language the script is written
      name - the name of the script that needs to be evaluated
      args - the arguments to be passed to the script during evaluation

  • Method Details

    • getLanguage

      public String getLanguage()
      Return the language the script is written.
      Returns:
      the language the script is written

    • getName

      public String getName()
      Return the name of the script that needs to be evaluated.
      Returns:
      the name of the script that needs to be evaluated

    • getArgs

      public Object[] getArgs()
      Return the arguments to be passed to the script during evaluation.
      Returns:
      the arguments to be passed to the script during evaluation

    • readExternal

      public void readExternal(DataInput in) throws IOException
      Description copied from interface: ExternalizableLite
      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
      Description copied from interface: ExternalizableLite
      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 in) throws IOException
      Description copied from interface: PortableObject
      Restore the contents of a user type instance by reading its state using the specified PofReader object.
      Specified by:
      readExternal in interface PortableObject
      Parameters:
      in - the PofReader from which to read the object's state
      Throws:
      IOException - if an I/O error occurs

    • writeExternal

      public void writeExternal(PofWriter out) throws IOException
      Description copied from interface: PortableObject
      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:
      out - the PofWriter to which to write the object's state
      Throws:
      IOException - if an I/O error occurs