org.eclipse.hyades.execution.remote
Class ExecutionEnvironmentSkeleton

java.lang.Object
  org.eclipse.hyades.execution.remote.RemoteObjectSkeleton
      org.eclipse.hyades.execution.remote.ExecutionComponentSkeleton
          org.eclipse.hyades.execution.remote.ExecutionEnvironmentSkeleton

All Implemented Interfaces:

IExecutionComponent, IExecutionEnvironment, IRemoteObject

public class ExecutionEnvironmentSkeleton

extends ExecutionComponentSkeleton

implements IExecutionEnvironment

Field Summary

Fields inherited from class org.eclipse.hyades.execution.remote.RemoteObjectSkeleton

delegate, sessionContext, uniqueId

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

DEAD, INACTIVE, NOT_CONFIGURED, READY, SUSPENDED

Constructor Summary

ExecutionEnvironmentSkeleton()

ExecutionEnvironmentSkeleton(IExecutionComponent delegate, java.lang.Integer id)

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 class org.eclipse.hyades.execution.remote.ExecutionComponentSkeleton

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

Methods inherited from class org.eclipse.hyades.execution.remote.RemoteObjectSkeleton

delegateRemoteCall, getDelegate, getSessionContext, getUniqueId, setDelegate, setId, setSessionContext

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, init, removeChild, removeExecutionComponentStateChangeListener, sendMessage, setParent

Constructor Detail

ExecutionEnvironmentSkeleton

public ExecutionEnvironmentSkeleton()

ExecutionEnvironmentSkeleton

public ExecutionEnvironmentSkeleton(IExecutionComponent delegate,
                                    java.lang.Integer id)

Method Detail

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.setEnv(org.eclipse.hyades.execution.core.IOrderedProperty)