org.eclipse.hyades.execution.core
Interface IExecutionEnvironment

All Superinterfaces:

IExecutionComponent

All Known Implementing Classes:

ExecutionEnvironmentImpl, ExecutionEnvironmentSkeleton, ExecutionEnvironmentStub, JavaExecutionEnvironment

public interface IExecutionEnvironment
extends IExecutionComponent

IExecutionEnvironment is a specialized IExecutionComponent that has knowledge about the environment that the IExecutionComponent's and its children reside within.

Field Summary

Fields inherited from interface org.eclipse.hyades.execution.core.IExecutionComponent

DEAD, INACTIVE, NOT_CONFIGURED, READY, SUSPENDED

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.
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 interface org.eclipse.hyades.execution.core.IExecutionComponent

addChild, addExecutionComponentStateChangeListener, fireStateChangeEvent, getChildById, getChildByName, getChildren, getId, getName, getNode, getParent, getState, getType, getVersion, handleMessage, init, removeChild, removeExecutionComponentStateChangeListener, sendMessage, setParent

Method Detail

getEnv

IOrderedProperty[] getEnv()
                          throws ExecutionComponentStateException

Get the entire environment as it is currently set.

Returns:

an array of IOrderedProperty objects

Throws:

ExecutionComponentStateException

getEnvByName

IOrderedProperty getEnvByName(java.lang.String name)
                              throws ExecutionComponentStateException

Get the environment variable by name.

Parameters:

name - The name of the IOrderedProperty to lookup.

Returns:

the IOrderedProperty if it exists, null otherwise

Throws:

ExecutionComponentStateException

setEnv

void setEnv(IOrderedProperty[] env)
            throws ExecutionComponentStateException

Set the entire environment, overwriting an existing properties.

Parameters:

env - An array of IOrderedProperty objects to set the environment

Throws:

ExecutionComponentStateException

setEnv

void setEnv(IOrderedProperty env)
            throws ExecutionComponentStateException

Set the single environment variable, overwriting the existing property.

Parameters:

env - The IOrderedProperty object to set the environment

Throws:

ExecutionComponentStateException

addEnv

void addEnv(IOrderedProperty env)
            throws ExecutionComponentStateException

Add a property from the currently set environment. This does not check for like named properties.

Parameters:

env - The property to add

Throws:

ExecutionComponentStateException

removeProperty

IOrderedProperty removeProperty(java.lang.String name)
                                throws ExecutionComponentStateException

Remove a property from the currently set environment

Parameters:

name - The name of the property to remove

Throws:

ExecutionComponentStateException