Interface ScriptEngine


  • public interface ScriptEngine
    Manage scriptEngine variables, statements and script execution.
    Author:
    Matti Rinta-Nikkola
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      void del​(java.lang.String... vars)
      Deletes variables.
      default java.lang.Object deserialize​(java.lang.String value)
      Deserialize value
      java.lang.Object deserialize​(java.lang.String value, java.lang.String format)
      Deserialize value
      default java.lang.Object execute​(java.io.File script)
      Executes scriptEngine script
      java.lang.Object execute​(java.io.File script, java.lang.Object[] args)
      Executes scriptEngine script
      java.lang.Object execute​(java.lang.Object closure, java.lang.Object... args)
      Executes scriptEngine closure
      java.lang.Object execute​(java.lang.String statement)
      Executes scriptEngine statement
      default java.util.Map<java.lang.String,​java.lang.Object> find()
      Gets all variables with values
      java.util.Map<java.lang.String,​java.lang.Object> find​(java.lang.String name)
      Gets all the variables that match the name.
      java.lang.Object get​(java.lang.String name)
      Gets variable value
      java.util.List<java.lang.String> getDeserializationFormats()  
      java.lang.String getEngineName()  
      java.util.Collection<java.lang.String> getExtensions()  
      Completer getScriptCompleter()  
      java.util.List<java.lang.String> getSerializationFormats()  
      boolean hasVariable​(java.lang.String name)
      Tests if console variable exists
      void persist​(java.nio.file.Path file, java.lang.Object object)
      Persists object value to file.
      void persist​(java.nio.file.Path file, java.lang.Object object, java.lang.String format)
      Persists object value to file.
      void put​(java.lang.String name, java.lang.Object value)
      Creates variable
      java.lang.String toJson​(java.lang.Object object)
      Serialize object to JSON string.
      java.util.Map<java.lang.String,​java.lang.Object> toMap​(java.lang.Object object)
      Converts object fields to map.
      java.lang.String toString​(java.lang.Object object)
      Converts object to string.
    • Method Detail

      • getEngineName

        java.lang.String getEngineName()
        Returns:
        scriptEngine name
      • getExtensions

        java.util.Collection<java.lang.String> getExtensions()
        Returns:
        script file name extensions
      • getScriptCompleter

        Completer getScriptCompleter()
        Returns:
        script tab completer
      • hasVariable

        boolean hasVariable​(java.lang.String name)
        Tests if console variable exists
        Parameters:
        name - variable name
        Returns:
        true if variable exists
      • put

        void put​(java.lang.String name,
                 java.lang.Object value)
        Creates variable
        Parameters:
        name - variable name
        value - value
      • get

        java.lang.Object get​(java.lang.String name)
        Gets variable value
        Parameters:
        name - variable name
        Returns:
        value of the variable
      • find

        default java.util.Map<java.lang.String,​java.lang.Object> find()
        Gets all variables with values
        Returns:
        map of the variables
      • find

        java.util.Map<java.lang.String,​java.lang.Object> find​(java.lang.String name)
        Gets all the variables that match the name. Name can contain * wild cards.
        Parameters:
        name - variable name
        Returns:
        map the variables
      • del

        void del​(java.lang.String... vars)
        Deletes variables. Variable name can contain * wild cards.
        Parameters:
        vars - variables to be deleted
      • toJson

        java.lang.String toJson​(java.lang.Object object)
        Serialize object to JSON string.
        Parameters:
        object - object to serialize to JSON
        Returns:
        formatted JSON string
      • toString

        java.lang.String toString​(java.lang.Object object)
        Converts object to string.
        Parameters:
        object - the object
        Returns:
        object string value
      • toMap

        java.util.Map<java.lang.String,​java.lang.Object> toMap​(java.lang.Object object)
        Converts object fields to map.
        Parameters:
        object - the object
        Returns:
        object fields map
      • deserialize

        default java.lang.Object deserialize​(java.lang.String value)
        Deserialize value
        Parameters:
        value - the value
        Returns:
        deserialized value
      • deserialize

        java.lang.Object deserialize​(java.lang.String value,
                                     java.lang.String format)
        Deserialize value
        Parameters:
        value - the value
        format - serialization format
        Returns:
        deserialized value
      • getSerializationFormats

        java.util.List<java.lang.String> getSerializationFormats()
        Returns:
        Supported serialization formats
      • getDeserializationFormats

        java.util.List<java.lang.String> getDeserializationFormats()
        Returns:
        Supported deserialization formats
      • persist

        void persist​(java.nio.file.Path file,
                     java.lang.Object object)
        Persists object value to file.
        Parameters:
        file - file
        object - object
      • persist

        void persist​(java.nio.file.Path file,
                     java.lang.Object object,
                     java.lang.String format)
        Persists object value to file.
        Parameters:
        file - the file
        object - the object
        format - serialization format
      • execute

        java.lang.Object execute​(java.lang.String statement)
                          throws java.lang.Exception
        Executes scriptEngine statement
        Parameters:
        statement - the statement
        Returns:
        result
        Throws:
        java.lang.Exception - in case of error
      • execute

        default java.lang.Object execute​(java.io.File script)
                                  throws java.lang.Exception
        Executes scriptEngine script
        Parameters:
        script - the script
        Returns:
        result
        Throws:
        java.lang.Exception - in case of error
      • execute

        java.lang.Object execute​(java.io.File script,
                                 java.lang.Object[] args)
                          throws java.lang.Exception
        Executes scriptEngine script
        Parameters:
        script - the script
        args - arguments
        Returns:
        result
        Throws:
        java.lang.Exception - in case of error
      • execute

        java.lang.Object execute​(java.lang.Object closure,
                                 java.lang.Object... args)
        Executes scriptEngine closure
        Parameters:
        closure - closure
        args - arguments
        Returns:
        result