org.bee.processor
Interface Instruction

All Known Implementing Classes:
AbstractBlock, AbstractValue, Bee, Block, Dependency, Echo, Else, Expression, For, Function, If, Interrupt, OnException, OnExit, Operator, Parameter, Switch, Target, Task, Then, Value, Variable

public interface Instruction


Nested Class Summary
static interface Instruction.NameSpace
          Generally name space keep object values reachable by keys
 
Field Summary
static java.lang.String ATTR_CODE
           
static java.lang.String ATTR_COMMENT
           
static java.lang.String ATTR_DIR
           
static java.lang.String ATTR_ERROUT
           
static java.lang.String ATTR_ERROUT_STREAM
           
static java.lang.String ATTR_EXEC
           
static java.lang.String ATTR_IN
           
static java.lang.String ATTR_NAME
           
static java.lang.String ATTR_OPTIONS
           
static java.lang.String ATTR_PATH
           
static java.lang.String ATTR_PROCESSONLY
           
static java.lang.String ATTR_PROPERTY
           
static java.lang.String ATTR_SEPARATOR
           
static java.lang.String ATTR_STDIN
           
static java.lang.String ATTR_STDOUT
           
static java.lang.String ATTR_STDOUT_STREAM
           
static java.lang.String ATTR_TARGET
           
static java.lang.String ATTR_TYPE
           
static java.lang.String ATTR_URL
           
static java.lang.String ATTR_VALUE
           
static java.lang.String ATTR_VARIABLE
           
static java.lang.String RESERVE_BUILD_FILE
           
static java.lang.String RESERVE_CLASS_LIB
           
static java.lang.String RESERVE_NAME_ARGS
           
static java.lang.String RESERVE_NAME_DIR
           
static java.lang.String RESERVE_NAME_ERROR
           
static java.lang.String RESERVE_NAME_EXCEPTION
           
static java.lang.String RESERVE_OPTION_NOINPUT
           
static java.lang.String TYPE_BOOL
           
static java.lang.String TYPE_DATE
           
static java.lang.String TYPE_DIRECTORY
           
static java.lang.String TYPE_FILE
           
static java.lang.String TYPE_NUMBER
           
static java.lang.String TYPE_URL
           
static java.lang.String TYPE_VARIABLE
           
 
Method Summary
 void childDone(Instruction child)
          Child notifies a parent that evaluation done, and a parent can use it for own evaluation
 InfoHolder eval()
          Returns value of instruction
 java.lang.String[] getAllowedAttributeNames()
          Funtions used only for diagnostic purpose to check if not allowed attribute for instruction used.
 org.xml.sax.ContentHandler getHandler()
          provides a handler to parce instruction
 java.lang.String getName()
          returns instruction name
 Instruction.NameSpace getNameSpace()
          return current name space
 Instruction getParent()
          returns parent, not sure that we need it at all
 XmlPath getPath()
          Provides path to the instruction
 void setParent(Instruction parent)
          call back from processor to set parent instruction
 

Field Detail

ATTR_NAME

static final java.lang.String ATTR_NAME
See Also:
Constant Field Values

ATTR_VARIABLE

static final java.lang.String ATTR_VARIABLE
See Also:
Constant Field Values

ATTR_TARGET

static final java.lang.String ATTR_TARGET
See Also:
Constant Field Values

ATTR_TYPE

static final java.lang.String ATTR_TYPE
See Also:
Constant Field Values

ATTR_PROPERTY

static final java.lang.String ATTR_PROPERTY
See Also:
Constant Field Values

ATTR_IN

static final java.lang.String ATTR_IN
See Also:
Constant Field Values

ATTR_EXEC

static final java.lang.String ATTR_EXEC
See Also:
Constant Field Values

ATTR_CODE

static final java.lang.String ATTR_CODE
See Also:
Constant Field Values

ATTR_DIR

static final java.lang.String ATTR_DIR
See Also:
Constant Field Values

ATTR_URL

static final java.lang.String ATTR_URL
See Also:
Constant Field Values

ATTR_COMMENT

static final java.lang.String ATTR_COMMENT
See Also:
Constant Field Values

ATTR_VALUE

static final java.lang.String ATTR_VALUE
See Also:
Constant Field Values

ATTR_PATH

static final java.lang.String ATTR_PATH
See Also:
Constant Field Values

ATTR_OPTIONS

static final java.lang.String ATTR_OPTIONS
See Also:
Constant Field Values

ATTR_SEPARATOR

static final java.lang.String ATTR_SEPARATOR
See Also:
Constant Field Values

ATTR_PROCESSONLY

static final java.lang.String ATTR_PROCESSONLY
See Also:
Constant Field Values

ATTR_STDOUT

static final java.lang.String ATTR_STDOUT
See Also:
Constant Field Values

ATTR_ERROUT

static final java.lang.String ATTR_ERROUT
See Also:
Constant Field Values

ATTR_STDIN

static final java.lang.String ATTR_STDIN
See Also:
Constant Field Values

ATTR_STDOUT_STREAM

static final java.lang.String ATTR_STDOUT_STREAM
See Also:
Constant Field Values

ATTR_ERROUT_STREAM

static final java.lang.String ATTR_ERROUT_STREAM
See Also:
Constant Field Values

RESERVE_NAME_DIR

static final java.lang.String RESERVE_NAME_DIR
See Also:
Constant Field Values

RESERVE_NAME_ARGS

static final java.lang.String RESERVE_NAME_ARGS
See Also:
Constant Field Values

RESERVE_NAME_ERROR

static final java.lang.String RESERVE_NAME_ERROR
See Also:
Constant Field Values

RESERVE_NAME_EXCEPTION

static final java.lang.String RESERVE_NAME_EXCEPTION
See Also:
Constant Field Values

RESERVE_OPTION_NOINPUT

static final java.lang.String RESERVE_OPTION_NOINPUT
See Also:
Constant Field Values

RESERVE_BUILD_FILE

static final java.lang.String RESERVE_BUILD_FILE
See Also:
Constant Field Values

RESERVE_CLASS_LIB

static final java.lang.String RESERVE_CLASS_LIB
See Also:
Constant Field Values

TYPE_VARIABLE

static final java.lang.String TYPE_VARIABLE
See Also:
Constant Field Values

TYPE_FILE

static final java.lang.String TYPE_FILE
See Also:
Constant Field Values

TYPE_DIRECTORY

static final java.lang.String TYPE_DIRECTORY
See Also:
Constant Field Values

TYPE_URL

static final java.lang.String TYPE_URL
See Also:
Constant Field Values

TYPE_NUMBER

static final java.lang.String TYPE_NUMBER
See Also:
Constant Field Values

TYPE_DATE

static final java.lang.String TYPE_DATE
See Also:
Constant Field Values

TYPE_BOOL

static final java.lang.String TYPE_BOOL
See Also:
Constant Field Values
Method Detail

getHandler

org.xml.sax.ContentHandler getHandler()
provides a handler to parce instruction

Returns:

getPath

XmlPath getPath()
Provides path to the instruction

Returns:
XmlPath path
generally path can be modified outside, so it should return clone if path is statically calculated inside

eval

InfoHolder eval()
Returns value of instruction

Returns:
InfoHolder

setParent

void setParent(Instruction parent)
call back from processor to set parent instruction

Parameters:
parent -

getParent

Instruction getParent()
returns parent, not sure that we need it at all

Returns:
parent

childDone

void childDone(Instruction child)
Child notifies a parent that evaluation done, and a parent can use it for own evaluation

Parameters:
child -

getName

java.lang.String getName()
returns instruction name

Returns:
name

getAllowedAttributeNames

java.lang.String[] getAllowedAttributeNames()
Funtions used only for diagnostic purpose to check if not allowed attribute for instruction used.

Returns:
String[] names of allowed attribute, can return null if any attribute is allowed

getNameSpace

Instruction.NameSpace getNameSpace()
return current name space

Returns:
NameSpace where children can be stored makes no sense for simple variables