org.vishia.cmd

Interface JZtxtcmdEngine

All Superinterfaces:

javax.script.ScriptEngine

All Known Implementing Classes:

JZcmd, JZtxtcmd

public interface JZtxtcmdEngine
extends javax.script.ScriptEngine

This interface describes the JZcmd script engine as enhancment of the javax.script.ScriptEngine. This interface is implemented in org.vishia.zcmd.JZcmd which is located in the srcJava_Zbnf component because it needs the Zbnf parser. It is possible to implement that methods with another compiler and script language.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	sVersion Version, history and license.

Fields inherited from interface javax.script.ScriptEngine

ARGV, ENGINE, ENGINE_VERSION, FILENAME, LANGUAGE, LANGUAGE_VERSION, NAME

Method Summary

Modifier and Type	Method and Description
java.lang.Object	evalSub(java.io.File fileScript, java.lang.String subroutine, java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> args, JZtxtcmdExecuter.ExecuteLevel execLevel) Executes a sub routine in a given script, which should be translated firstly.

Methods inherited from interface javax.script.ScriptEngine

createBindings, eval, eval, eval, eval, eval, eval, get, getBindings, getContext, getFactory, put, setBindings, setContext

Field Detail

sVersion

static final java.lang.String sVersion

Version, history and license.

• 2014-06-10 created. The access from the JZtxtcmdExecuter to the ScriptEngine is necessary.

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

Method Detail

evalSub

java.lang.Object evalSub(java.io.File fileScript,
                         java.lang.String subroutine,
                         java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> args,
                         JZtxtcmdExecuter.ExecuteLevel execLevel)
                  throws javax.script.ScriptException

Executes a sub routine in a given script, which should be translated firstly. This routine can be called inside another script with invocation:

 { ## any KZcmd script
     Map args;
     String args.name  = value;
     java org.vishia.zcmd.JZcmd.execSub(File:"path/JZcmdscript.jzcmd", "class.subroutine-Name", args, jzcmdsub);
 }
 

Parameters:

fileScript - The file which contains the script

subroutine - name of the subroutine in the script.

args - Arguments for this subroutine. They should be matching to the subroutine's formal arguments.

execLevel - Execution level from where this routine is called.

Returns:

Throws:

javax.script.ScriptException