Package net.sf.gridarta.plugin

Class PluginParameters

  • public class PluginParameters
extends java.lang.Object
    Makes basic Gridarta classes available to scripts.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addPluginParameter​(@NotNull java.lang.String name, @Nullable java.lang.Object value)
      Defines a variable to be passed to plugins.
      void setInterpreterValues​(@NotNull bsh.Interpreter interpreter, @NotNull PluginRunMode pluginRunMode)
      Adds variables to a Interpreter instance.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PluginParameters

        public PluginParameters()

    • Method Detail

      • addPluginParameter

        public void addPluginParameter​(@NotNull
                               @NotNull java.lang.String name,
                               @Nullable
                               @Nullable java.lang.Object value)
        Defines a variable to be passed to plugins.
        Parameters:
        name - the variable name
        value - the variable's value

      • setInterpreterValues

        public void setInterpreterValues​(@NotNull
                                 @NotNull bsh.Interpreter interpreter,
                                 @NotNull
                                 @NotNull PluginRunMode pluginRunMode)
                          throws bsh.EvalError
        Adds variables to a Interpreter instance.
        Parameters:
        interpreter - the interpreter to modify
        pluginRunMode - the plugin run mode to use
        Throws:
        bsh.EvalError - if a variable cannot be set