ArtifactScriptEngineFactory (org.macroing.cel4j.artifact API)

java.lang.Object
- org.macroing.cel4j.artifact.ArtifactScriptEngineFactory

All Implemented Interfaces:

javax.script.ScriptEngineFactory
```
public final class ArtifactScriptEngineFactory
extends java.lang.Object
implements javax.script.ScriptEngineFactory
```
ArtifactScriptEngineFactory is a ScriptEngineFactory that manages a ScriptEngine called Artifact that evaluates a super-set of Java source code.
The ScriptEngine provided compiles the source code into CompiledScripts and loads them, using the context ClassLoader. It caches the CompiledScripts using a normalized version of the source code provided for that CompiledScript. By doing so, no re-compilation will be performed when you add whitespace in other places than String literals.
To demonstrate its use, here is an example:
```
 
 ScriptEngineManager scriptEngineManager = new ScriptEngineManager();
 
 ScriptEngine scriptEngine = scriptEngineManager.getEngineByExtension("java");
 scriptEngine.eval("System.out.println(\"Hello, World!\"); return true;");
 
 
```
As you can see in the example above, you can return a result. Although you can, it's not necessary. If nothing is returned by you, null will be returned by default.
If a variable starts with a dollar sign ($), followed by a variable name (a Java identifier), that variable will be substituted for a variable in the ScriptContext and cast to its type. Lets say you have a variable $string that refers to a variable called "string" in the ScriptContext, and that variable is of type String. A call such as $string.length() would return the length of the String variable. Note, however, that this assumes the variable already exists in the ScriptContext prior to the evaluation of the current script. Adding a variable to the ScriptContext and then using this variable substitution mechanism to get that variable in the same script won't work. The reason for this, is that the variable substitution is performed prior to the evaluation of the script itself.
Since:

1.0.0

Author:

Jörgen Lundgren

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String ENGINE_NAME
A String denoting the name of the ScriptEngine Artifact.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ENGINE_NAME` A `String` denoting the name of the `ScriptEngine` Artifact.

Constructor Summary

Constructors
Constructor and Description

ArtifactScriptEngineFactory()
Constructs a new ArtifactScriptEngineFactory instance.

Constructors
Constructor and Description
`ArtifactScriptEngineFactory()` Constructs a new `ArtifactScriptEngineFactory` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getEngineName()` Returns a `String` with the name of the `ScriptEngine`.
`java.lang.String`	`getEngineVersion()` Returns a `String` with the version of the `ScriptEngine`.
`java.util.List<java.lang.String>`	`getExtensions()` Returns a `List` with extensions.
`java.lang.String`	`getLanguageName()` Returns a `String` with the name of the language.
`java.lang.String`	`getLanguageVersion()` Returns a `String` with the version of the language.
`java.lang.String`	`getMethodCallSyntax(java.lang.String object, java.lang.String method, java.lang.String... args)` Returns an empty `String` at this time.
`java.util.List<java.lang.String>`	`getMimeTypes()` Returns a `List` with mime-types.
`java.util.List<java.lang.String>`	`getNames()` Returns a `List` with names.
`java.lang.String`	`getOutputStatement(java.lang.String toDisplay)` Returns an empty `String` at this time.
`java.lang.Object`	`getParameter(java.lang.String key)` Returns an `Object` value based on a `String` key.
`java.lang.String`	`getProgram(java.lang.String... statements)` Returns an empty `String` at this time.
`javax.script.ScriptEngine`	`getScriptEngine()` Returns the `ScriptEngine`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ENGINE_NAME
```
public static final java.lang.String ENGINE_NAME
```
    A String denoting the name of the ScriptEngine Artifact.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ArtifactScriptEngineFactory
```
public ArtifactScriptEngineFactory()
```
    Constructs a new ArtifactScriptEngineFactory instance.
- Method Detail
  - getExtensions
```
public java.util.List<java.lang.String> getExtensions()
```
    Returns a List with extensions.
    The currently supported extensions are ".java" and "java".
    
    Specified by:
    
    getExtensions in interface javax.script.ScriptEngineFactory
    
    Returns:
    
    a List with extensions
  - getMimeTypes
```
public java.util.List<java.lang.String> getMimeTypes()
```
    Returns a List with mime-types.
    There are currently no supported mime-types.
    
    Specified by:
    
    getMimeTypes in interface javax.script.ScriptEngineFactory
    
    Returns:
    
    a List with mime-types
  - getNames
```
public java.util.List<java.lang.String> getNames()
```
    Returns a List with names.
    The currently supported names are "artifact" and "java".
    
    Specified by:
    
    getNames in interface javax.script.ScriptEngineFactory
    
    Returns:
    
    a List with names
  - getParameter
```
public java.lang.Object getParameter(java.lang.String key)
```
    Returns an Object value based on a String key.
    The key may be null.
    
    Specified by:
    
    getParameter in interface javax.script.ScriptEngineFactory
    
    Parameters:
    
    key - the key to return a value from
    
    Returns:
    
    an Object value based on a String key
  - getScriptEngine
```
public javax.script.ScriptEngine getScriptEngine()
```
    Returns the ScriptEngine.
    It may be cached.
    
    Specified by:
    
    getScriptEngine in interface javax.script.ScriptEngineFactory
    
    Returns:
    
    the ScriptEngine
  - getEngineName
```
public java.lang.String getEngineName()
```
    Returns a String with the name of the ScriptEngine.
    The name is "Artifact".
    
    Specified by:
    
    getEngineName in interface javax.script.ScriptEngineFactory
    
    Returns:
    
    a String with the name of the ScriptEngine
  - getEngineVersion
```
public java.lang.String getEngineVersion()
```
    Returns a String with the version of the ScriptEngine.
    The current version is "1.0.0".
    
    Specified by:
    
    getEngineVersion in interface javax.script.ScriptEngineFactory
    
    Returns:
    
    a String with the version of the ScriptEngine
  - getLanguageName
```
public java.lang.String getLanguageName()
```
    Returns a String with the name of the language.
    The name is "Java".
    
    Specified by:
    
    getLanguageName in interface javax.script.ScriptEngineFactory
    
    Returns:
    
    a String with the name of the language
  - getLanguageVersion
```
public java.lang.String getLanguageVersion()
```
    Returns a String with the version of the language.
    The current version is "8".
    
    Specified by:
    
    getLanguageVersion in interface javax.script.ScriptEngineFactory
    
    Returns:
    
    a String with the version of the language
  - getMethodCallSyntax
```
public java.lang.String getMethodCallSyntax(java.lang.String object,
                                            java.lang.String method,
                                            java.lang.String... args)
```
    Returns an empty String at this time.
    
    Specified by:
    
    getMethodCallSyntax in interface javax.script.ScriptEngineFactory
    
    Parameters:
    
    object - a String with an object
    
    method - a String with a method
    
    args - a String array with parameter arguments
    
    Returns:
    
    an empty String at this time
  - getOutputStatement
```
public java.lang.String getOutputStatement(java.lang.String toDisplay)
```
    Returns an empty String at this time.
    
    Specified by:
    
    getOutputStatement in interface javax.script.ScriptEngineFactory
    
    Parameters:
    
    toDisplay - a String to display
    
    Returns:
    
    an empty String at this time
  - getProgram
```
public java.lang.String getProgram(java.lang.String... statements)
```
    Returns an empty String at this time.
    
    Specified by:
    
    getProgram in interface javax.script.ScriptEngineFactory
    
    Parameters:
    
    statements - a String array with statements
    
    Returns:
    
    an empty String at this time

Class ArtifactScriptEngineFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ENGINE_NAME

Constructor Detail

ArtifactScriptEngineFactory

Method Detail

getExtensions

getMimeTypes

getNames

getParameter

getScriptEngine

getEngineName

getEngineVersion

getLanguageName

getLanguageVersion

getMethodCallSyntax

getOutputStatement

getProgram