A E G I O P R S T

A

AbstractShellCommand - Class in org.overlord.sramp.shell.api

Base class for shell commands.

AbstractShellCommand() - Constructor for class org.overlord.sramp.shell.api.AbstractShellCommand

Constructor.

addHandler(ShellContextEventHandler) - Method in interface org.overlord.sramp.shell.api.ShellContext

Adds an event handler to the shell context.

addHandler(ShellContextEventHandler) - Method in class org.overlord.sramp.shell.api.SimpleShellContext

Arguments - Class in org.overlord.sramp.shell.api

A class that can parse the arguments that should be passed to a command.

Arguments(String) - Constructor for class org.overlord.sramp.shell.api.Arguments

Constructor.

Arguments(String, boolean) - Constructor for class org.overlord.sramp.shell.api.Arguments

Constructor.

E

execute() - Method in interface org.overlord.sramp.shell.api.ShellCommand

Called to execute the command.

G

getArgumentIndex() - Method in exception org.overlord.sramp.shell.api.InvalidCommandArgumentException

getArguments() - Method in class org.overlord.sramp.shell.api.AbstractShellCommand

Gets the command's arguments.

getContext() - Method in class org.overlord.sramp.shell.api.AbstractShellCommand

getNamespace() - Method in interface org.overlord.sramp.shell.api.ShellCommandProvider

Returns the namespace provided by this command provider.

getVariable(QName) - Method in interface org.overlord.sramp.shell.api.ShellContext

Gets a variable from the context.

getVariable(QName) - Method in class org.overlord.sramp.shell.api.SimpleShellContext

I

InvalidCommandArgumentException - Exception in org.overlord.sramp.shell.api

An exception thrown when an argument to a command is invalid.

InvalidCommandArgumentException(int, String) - Constructor for exception org.overlord.sramp.shell.api.InvalidCommandArgumentException

Constructor.

O

onAdd(Object) - Method in interface org.overlord.sramp.shell.api.ShellContextVariableLifecycleHandler

Called before the object is added to the context.

onContextDestroyed(Object) - Method in interface org.overlord.sramp.shell.api.ShellContextVariableLifecycleHandler

Called when the shell context is destroyed.

onRemove(Object) - Method in interface org.overlord.sramp.shell.api.ShellContextVariableLifecycleHandler

Called after the object has been removed from the context.

onVariableAdded(QName, Object) - Method in interface org.overlord.sramp.shell.api.ShellContextEventHandler

Called when a variable is added to the context.

onVariableChanged(QName, Object) - Method in interface org.overlord.sramp.shell.api.ShellContextEventHandler

Called when a variable is changed.

onVariableRemoved(QName) - Method in interface org.overlord.sramp.shell.api.ShellContextEventHandler

Called when a variable is removed.

optionalArgument(int) - Method in class org.overlord.sramp.shell.api.AbstractShellCommand

Returns the optional argument at the given index.

optionalArgument(int, String) - Method in class org.overlord.sramp.shell.api.AbstractShellCommand

Returns the optional argument at the given index.

org.overlord.sramp.shell.api - package org.overlord.sramp.shell.api

P

print(String, Object...) - Method in class org.overlord.sramp.shell.api.AbstractShellCommand

print(String, Object...) - Method in interface org.overlord.sramp.shell.api.ShellCommand

Prints the given message to the output stream.

printHelp() - Method in interface org.overlord.sramp.shell.api.ShellCommand

Prints the help text for this command.

printUsage() - Method in interface org.overlord.sramp.shell.api.ShellCommand

Prints the usage help for this command.

provideCommands() - Method in interface org.overlord.sramp.shell.api.ShellCommandProvider

Called to get the collection of commands contributed by the provider.

R

removeCommandName() - Method in class org.overlord.sramp.shell.api.Arguments

Remove, decode, and return the command name.

removeHandler(ShellContextEventHandler) - Method in interface org.overlord.sramp.shell.api.ShellContext

Removes an event handler from the shell context.

removeHandler(ShellContextEventHandler) - Method in class org.overlord.sramp.shell.api.SimpleShellContext

removeVariable(QName) - Method in interface org.overlord.sramp.shell.api.ShellContext

Removes a variable from the context.

removeVariable(QName) - Method in class org.overlord.sramp.shell.api.SimpleShellContext

requiredArgument(int, String) - Method in class org.overlord.sramp.shell.api.AbstractShellCommand

Returns the argument at the given index.

S

setArgumentIndex(int) - Method in exception org.overlord.sramp.shell.api.InvalidCommandArgumentException

setArguments(Arguments) - Method in class org.overlord.sramp.shell.api.AbstractShellCommand

setArguments(Arguments) - Method in interface org.overlord.sramp.shell.api.ShellCommand

Sets the arguments that can be used by this command.

setContext(ShellContext) - Method in class org.overlord.sramp.shell.api.AbstractShellCommand

setContext(ShellContext) - Method in interface org.overlord.sramp.shell.api.ShellCommand

The shell context.

setOutput(Writer) - Method in class org.overlord.sramp.shell.api.AbstractShellCommand

setOutput(Writer) - Method in interface org.overlord.sramp.shell.api.ShellCommand

Configure the command's output.

setVariable(QName, Object) - Method in interface org.overlord.sramp.shell.api.ShellContext

Sets a variable in the context.

setVariable(QName, Object, ShellContextVariableLifecycleHandler) - Method in interface org.overlord.sramp.shell.api.ShellContext

Sets a variable in the context.

setVariable(QName, Object) - Method in class org.overlord.sramp.shell.api.SimpleShellContext

setVariable(QName, Object, ShellContextVariableLifecycleHandler) - Method in class org.overlord.sramp.shell.api.SimpleShellContext

ShellCommand - Interface in org.overlord.sramp.shell.api

Interface implemented by all shell commands.

ShellCommandProvider - Interface in org.overlord.sramp.shell.api

Provides comands - used by the shell command factory when creating the map of available shell commands.

ShellContext - Interface in org.overlord.sramp.shell.api

The context available to all shell commands.

ShellContextEventHandler - Interface in org.overlord.sramp.shell.api

Implement this interface to listen for shell context events.

ShellContextVariableLifecycleHandler - Interface in org.overlord.sramp.shell.api

Lifecycle handler for a shell context variable.

SimpleShellContext - Class in org.overlord.sramp.shell.api

A simple implementation of ShellContext.

SimpleShellContext() - Constructor for class org.overlord.sramp.shell.api.SimpleShellContext

Constructor.

T

tabCompletion(String, List<CharSequence>) - Method in class org.overlord.sramp.shell.api.AbstractShellCommand

tabCompletion(String, List<CharSequence>) - Method in interface org.overlord.sramp.shell.api.ShellCommand

Handle tab completion for the command.

A E G I O P R S T