org.overlord.sramp.shell.api

Interface ShellContext

All Known Implementing Classes:

SimpleShellContext

public interface ShellContext

The context available to all shell commands.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
void	addHandler(ShellContextEventHandler handler) Adds an event handler to the shell context.
Object	getVariable(QName name) Gets a variable from the context.
void	removeHandler(ShellContextEventHandler handler) Removes an event handler from the shell context.
Object	removeVariable(QName name) Removes a variable from the context.
void	setVariable(QName name, Object object) Sets a variable in the context.
void	setVariable(QName name, Object object, ShellContextVariableLifecycleHandler lifecycleHandler) Sets a variable in the context.

Method Detail

setVariable

void setVariable(QName name,
               Object object)

Sets a variable in the context.

Parameters:

name -

object -

setVariable

void setVariable(QName name,
               Object object,
               ShellContextVariableLifecycleHandler lifecycleHandler)

Sets a variable in the context.

Parameters:

name -

object -

lifecycleHandler -

addHandler

void addHandler(ShellContextEventHandler handler)

Adds an event handler to the shell context.

Parameters:

handler -

removeHandler

void removeHandler(ShellContextEventHandler handler)

Removes an event handler from the shell context.

Parameters:

handler -

getVariable

Object getVariable(QName name)

Gets a variable from the context.

Parameters:

name -

removeVariable

Object removeVariable(QName name)

Removes a variable from the context. Returns the object that was removed.

Parameters:

name -