TPTP 4.1.0 Platform Project
Public API Specification

org.eclipse.hyades.execution.core.impl
Class ExecutionEnvironmentImpl

java.lang.Object
  extended byorg.eclipse.hyades.execution.core.impl.ExecutionComponentImpl
      extended byorg.eclipse.hyades.execution.core.impl.ExecutionEnvironmentImpl
All Implemented Interfaces:
IExecutionComponent, IExecutionEnvironment
Direct Known Subclasses:
JavaExecutionEnvironment

public class ExecutionEnvironmentImpl
extends ExecutionComponentImpl
implements IExecutionEnvironment


Field Summary
protected static java.util.ArrayList originalProcessEnvironment
           
protected  java.util.ArrayList processEnvironment
           
 
Fields inherited from class org.eclipse.hyades.execution.core.impl.ExecutionComponentImpl
children, id, name, node, parent, state, stateChangeListeners, type, version
 
Fields inherited from interface org.eclipse.hyades.execution.core.IExecutionComponent
DEAD, INACTIVE, NOT_CONFIGURED, READY, SUSPENDED
 
Constructor Summary
ExecutionEnvironmentImpl()
           
 
Method Summary
 void addEnv(IOrderedProperty env)
          Add a property from the currently set environment.
 IOrderedProperty[] getEnv()
          Get the entire environment as it is currently set.
 IOrderedProperty getEnvByName(java.lang.String name)
          Get the environment variable by name.
 void init()
          Initialization routine
 IOrderedProperty removeProperty(java.lang.String name)
          Remove a property from the currently set environment
 void setEnv(IOrderedProperty env)
          Set the single environment variable, overwriting the existing property.
 void setEnv(IOrderedProperty[] env)
          Set the entire environment, overwriting an existing properties.
 
Methods inherited from class org.eclipse.hyades.execution.core.impl.ExecutionComponentImpl
addChild, addExecutionComponentStateChangeListener, fireStateChangeEvent, getChildById, getChildByName, getChildren, getId, getName, getNode, getParent, getState, getType, getVersion, handleMessage, removeChild, removeExecutionComponentStateChangeListener, sendMessage, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.hyades.execution.core.IExecutionComponent
addChild, addExecutionComponentStateChangeListener, fireStateChangeEvent, getChildById, getChildByName, getChildren, getId, getName, getNode, getParent, getState, getType, getVersion, handleMessage, removeChild, removeExecutionComponentStateChangeListener, sendMessage, setParent
 

Field Detail

originalProcessEnvironment

protected static java.util.ArrayList originalProcessEnvironment

processEnvironment

protected java.util.ArrayList processEnvironment
Constructor Detail

ExecutionEnvironmentImpl

public ExecutionEnvironmentImpl()
Method Detail

init

public void init()
Initialization routine

Specified by:
init in interface IExecutionComponent
Overrides:
init in class ExecutionComponentImpl
See Also:
IExecutionComponent.init()

getEnv

public IOrderedProperty[] getEnv()
                          throws ExecutionComponentStateException
Description copied from interface: IExecutionEnvironment
Get the entire environment as it is currently set.

Specified by:
getEnv in interface IExecutionEnvironment
Returns:
an array of IOrderedProperty objects
Throws:
ExecutionComponentStateException
See Also:
IExecutionEnvironment.getEnv()

getEnvByName

public IOrderedProperty getEnvByName(java.lang.String name)
                              throws ExecutionComponentStateException
Description copied from interface: IExecutionEnvironment
Get the environment variable by name.

Specified by:
getEnvByName in interface IExecutionEnvironment
Parameters:
name - The name of the IOrderedProperty to lookup.
Returns:
the IOrderedProperty if it exists, null otherwise
Throws:
ExecutionComponentStateException
See Also:
IExecutionEnvironment.getEnvByName(java.lang.String)

setEnv

public void setEnv(IOrderedProperty[] env)
            throws ExecutionComponentStateException
Description copied from interface: IExecutionEnvironment
Set the entire environment, overwriting an existing properties.

Specified by:
setEnv in interface IExecutionEnvironment
Parameters:
env - An array of IOrderedProperty objects to set the environment
Throws:
ExecutionComponentStateException
See Also:
IExecutionEnvironment.setEnv(org.eclipse.hyades.execution.core.IOrderedProperty)

addEnv

public void addEnv(IOrderedProperty env)
            throws ExecutionComponentStateException
Description copied from interface: IExecutionEnvironment
Add a property from the currently set environment. This does not check for like named properties.

Specified by:
addEnv in interface IExecutionEnvironment
Parameters:
env - The property to add
Throws:
ExecutionComponentStateException
See Also:
IExecutionEnvironment.addEnv(org.eclipse.hyades.execution.core.IOrderedProperty)

removeProperty

public IOrderedProperty removeProperty(java.lang.String name)
                                throws ExecutionComponentStateException
Description copied from interface: IExecutionEnvironment
Remove a property from the currently set environment

Specified by:
removeProperty in interface IExecutionEnvironment
Parameters:
name - The name of the property to remove
Throws:
ExecutionComponentStateException
See Also:
IExecutionEnvironment.removeProperty(java.lang.String)

setEnv

public void setEnv(IOrderedProperty env)
            throws ExecutionComponentStateException
Description copied from interface: IExecutionEnvironment
Set the single environment variable, overwriting the existing property.

Specified by:
setEnv in interface IExecutionEnvironment
Parameters:
env - The IOrderedProperty object to set the environment
Throws:
ExecutionComponentStateException
See Also:
IExecutionEnvironment.addEnv(org.eclipse.hyades.execution.core.IOrderedProperty)

TPTP 4.1.0 Platform Project
Public API Specification