Package org.eclipse.scanning.api.script

Enum Class ScriptLanguage

java.lang.Object
java.lang.Enum<ScriptLanguage>
org.eclipse.scanning.api.script.ScriptLanguage
All Implemented Interfaces:
Serializable, Comparable<ScriptLanguage>, Constable
public enum ScriptLanguage extends Enum<ScriptLanguage>
Language of the script supported. *NOTE* Not all scripting languages are supported by all implementations of the service.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BASH
    If you must
    GROOVY
    Uses GroovyScriptEngine to parse the input script and execute it on the server.
    JAVASCRIPT
    The ever popular scripting language
    JYTHON
    Jython with DAQ objects available or an exception thrown if they cannot be imported.
    PYTHON
    Full cpython, usually with numpy and scipy available.
    R
    Runs the famous statistical package R.
    RUBY
    To run ruby using jruby
    SPEC_PASTICHE
    Jython with the DSL extensions to make some commands look like spec This is slower to run than pure jython scripts because it must be parsed and run line by line.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ScriptLanguage
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ScriptLanguage[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • PYTHON

      public static final ScriptLanguage PYTHON
      Full cpython, usually with numpy and scipy available.

    • JYTHON

      public static final ScriptLanguage JYTHON
      Jython with DAQ objects available or an exception thrown if they cannot be imported.

    • SPEC_PASTICHE

      public static final ScriptLanguage SPEC_PASTICHE
      Jython with the DSL extensions to make some commands look like spec This is slower to run than pure jython scripts because it must be parsed and run line by line. It is also not possible to debug using pydev.

    • JAVASCRIPT

      public static final ScriptLanguage JAVASCRIPT
      The ever popular scripting language

    • GROOVY

      public static final ScriptLanguage GROOVY
      Uses GroovyScriptEngine to parse the input script and execute it on the server.

    • RUBY

      public static final ScriptLanguage RUBY
      To run ruby using jruby

    • R

      public static final ScriptLanguage R
      Runs the famous statistical package R. In order for the server to do this, it will have to have R installed separately and linked to the server.

    • BASH

      public static final ScriptLanguage BASH
      If you must

  • Method Details

    • values

      public static ScriptLanguage[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ScriptLanguage valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null