A C D E F G H I L N O P R S T U V

A

Alias - Interface in org.apache.geronimo.gshell.command

Convenient way to register an alias.

ALIASES_ROOT - Static variable in interface org.apache.geronimo.gshell.registry.CommandResolver

AliasRegistry - Interface in org.apache.geronimo.gshell.registry

Registry for command aliases.

Arguments - Class in org.apache.geronimo.gshell.command

Utils for command-line arguments.

Arguments() - Constructor for class org.apache.geronimo.gshell.command.Arguments

asString(Object[]) - Static method in class org.apache.geronimo.gshell.command.Arguments

asString(List) - Static method in class org.apache.geronimo.gshell.command.Arguments

C

close() - Method in interface org.apache.geronimo.gshell.shell.Shell

code - Variable in error org.apache.geronimo.gshell.notification.ExitNotification

Command - Interface in org.apache.geronimo.gshell.command

Provides facilites for a configured command instance.

CommandAction - Interface in org.apache.geronimo.gshell.command

Provides the user-action for a command.

CommandAction.Result - Enum in org.apache.geronimo.gshell.command

Enumeration for the basic return types of a command execution.

CommandAware - Interface in org.apache.geronimo.gshell.command

Marks a component as aware of it's Command.

CommandCompleter - Interface in org.apache.geronimo.gshell.command

Provides completion support for a command.

CommandContext - Interface in org.apache.geronimo.gshell.command

Provides commands with the context of its execution.

CommandDocumenter - Interface in org.apache.geronimo.gshell.command

Provides access to a commands documentation.

CommandException - Exception in org.apache.geronimo.gshell.command

Thrown to indicate a command failure.

CommandException(String) - Constructor for exception org.apache.geronimo.gshell.command.CommandException

CommandException(String, Throwable) - Constructor for exception org.apache.geronimo.gshell.command.CommandException

CommandException(Throwable) - Constructor for exception org.apache.geronimo.gshell.command.CommandException

CommandException() - Constructor for exception org.apache.geronimo.gshell.command.CommandException

CommandLine - Interface in org.apache.geronimo.gshell.commandline

A abstraction of an executable command-line.

CommandLineBuilder - Interface in org.apache.geronimo.gshell.commandline

Builds CommandLine instances ready for executing.

CommandLineExecutionFailed - Exception in org.apache.geronimo.gshell.commandline

Thrown when a command execution fails.

CommandLineExecutionFailed(Throwable) - Constructor for exception org.apache.geronimo.gshell.commandline.CommandLineExecutionFailed

CommandLineExecutor - Interface in org.apache.geronimo.gshell.commandline

Provides the ability to execute commands.

CommandLocation - Interface in org.apache.geronimo.gshell.command

Provides information about the location of a Command.

CommandRegistry - Interface in org.apache.geronimo.gshell.registry

Registry for commands.

CommandResolver - Interface in org.apache.geronimo.gshell.registry

Resolves Command instances for a given path.

CommandResult - Class in org.apache.geronimo.gshell.command

Provides the result of a command execution.

CommandResult.FailureResult - Class in org.apache.geronimo.gshell.command

Command execution resulting in a failure.

CommandResult.FailureResult(Throwable) - Constructor for class org.apache.geronimo.gshell.command.CommandResult.FailureResult

CommandResult.NotificationResult - Class in org.apache.geronimo.gshell.command

Command execution resulting in a notification.

CommandResult.NotificationResult(Notification) - Constructor for class org.apache.geronimo.gshell.command.CommandResult.NotificationResult

CommandResult.ValueResult - Class in org.apache.geronimo.gshell.command

Command execution resulting in a normal value.

CommandResult.ValueResult(Object) - Constructor for class org.apache.geronimo.gshell.command.CommandResult.ValueResult

COMMANDS_ROOT - Static variable in interface org.apache.geronimo.gshell.registry.CommandResolver

contains(String) - Method in class org.apache.geronimo.gshell.command.Variables

containsAlias(String) - Method in interface org.apache.geronimo.gshell.registry.AliasRegistry

containsCommand(String) - Method in interface org.apache.geronimo.gshell.registry.CommandRegistry

create(String) - Method in interface org.apache.geronimo.gshell.commandline.CommandLineBuilder

Build a command-line from the given input string.

create() - Method in interface org.apache.geronimo.gshell.shell.ShellFactory

Create a new shell instance.

createCompletors() - Method in interface org.apache.geronimo.gshell.command.CommandCompleter

D

DEFAULT_CODE - Static variable in error org.apache.geronimo.gshell.notification.ExitNotification

DuplicateCommandException - Exception in org.apache.geronimo.gshell.registry

Thrown to indicate a duplicate command registration attempt has failed.

DuplicateCommandException(String) - Constructor for exception org.apache.geronimo.gshell.registry.DuplicateCommandException

E

ERROR_CODE - Static variable in error org.apache.geronimo.gshell.notification.ExitNotification

ErrorNotification - Error in org.apache.geronimo.gshell.notification

Thrown to indicate an error notification state.

ErrorNotification(String) - Constructor for error org.apache.geronimo.gshell.notification.ErrorNotification

ErrorNotification(String, Throwable) - Constructor for error org.apache.geronimo.gshell.notification.ErrorNotification

ErrorNotification(Throwable) - Constructor for error org.apache.geronimo.gshell.notification.ErrorNotification

ErrorNotification() - Constructor for error org.apache.geronimo.gshell.notification.ErrorNotification

execute(ShellContext, Object[]) - Method in interface org.apache.geronimo.gshell.command.Command

Executes the commands configured action.

execute(CommandContext) - Method in interface org.apache.geronimo.gshell.command.CommandAction

Execute the command action.

execute(ShellContext, CommandLineExecutor) - Method in interface org.apache.geronimo.gshell.commandline.CommandLine

Execute the command-line.

execute(ShellContext, String) - Method in interface org.apache.geronimo.gshell.commandline.CommandLineExecutor

Execute a command-line, parsing out valid recognized syntax.

execute(ShellContext, String, Object[]) - Method in interface org.apache.geronimo.gshell.commandline.CommandLineExecutor

Execute command name/path with the given arguments.

execute(ShellContext, Object...) - Method in interface org.apache.geronimo.gshell.commandline.CommandLineExecutor

Execute a pre-processed command-line.

execute(String) - Method in interface org.apache.geronimo.gshell.shell.Shell

execute(String, Object[]) - Method in interface org.apache.geronimo.gshell.shell.Shell

execute(Object...) - Method in interface org.apache.geronimo.gshell.shell.Shell

exit(int) - Static method in error org.apache.geronimo.gshell.notification.ExitNotification

exit() - Static method in error org.apache.geronimo.gshell.notification.ExitNotification

ExitNotification - Error in org.apache.geronimo.gshell.notification

Thrown to indicate that the current shell should exit.

ExitNotification(int) - Constructor for error org.apache.geronimo.gshell.notification.ExitNotification

ExitNotification() - Constructor for error org.apache.geronimo.gshell.notification.ExitNotification

F

FATAL_CODE - Static variable in error org.apache.geronimo.gshell.notification.ExitNotification

G

get(String) - Method in class org.apache.geronimo.gshell.command.Variables

get(String, Class<T>) - Method in class org.apache.geronimo.gshell.command.Variables

get(String, Object) - Method in class org.apache.geronimo.gshell.command.Variables

get(boolean) - Static method in class org.apache.geronimo.gshell.shell.ShellContextHolder

get() - Static method in class org.apache.geronimo.gshell.shell.ShellContextHolder

getAction() - Method in interface org.apache.geronimo.gshell.command.Command

Returns the action of the command.

getAlias() - Method in interface org.apache.geronimo.gshell.command.Alias

getAlias(String) - Method in interface org.apache.geronimo.gshell.registry.AliasRegistry

getAliasNames() - Method in interface org.apache.geronimo.gshell.registry.AliasRegistry

getArguments() - Method in interface org.apache.geronimo.gshell.command.CommandContext

Provides access to the arguments to the command.

getCommand() - Method in interface org.apache.geronimo.gshell.command.CommandContext

Provides access to the command.

getCommand(String) - Method in interface org.apache.geronimo.gshell.registry.CommandRegistry

getCommandNames() - Method in interface org.apache.geronimo.gshell.registry.CommandRegistry

getCompleter() - Method in interface org.apache.geronimo.gshell.command.Command

Returns the completer for the command.

getContext() - Method in interface org.apache.geronimo.gshell.shell.Shell

getDescription() - Method in interface org.apache.geronimo.gshell.command.CommandDocumenter

Get the terse description of the command.

getDocumenter() - Method in interface org.apache.geronimo.gshell.command.Command

Returns the documenter for the command.

getFailure() - Method in class org.apache.geronimo.gshell.command.CommandResult

Returns the command failure cause.

getFullPath() - Method in interface org.apache.geronimo.gshell.command.CommandLocation

getIo() - Method in interface org.apache.geronimo.gshell.command.CommandContext

The Input/Output context for the command.

getIo() - Method in interface org.apache.geronimo.gshell.shell.ShellContext

getLocation() - Method in interface org.apache.geronimo.gshell.command.Command

Returns the location of the command

getMessages() - Method in interface org.apache.geronimo.gshell.command.Command

Returns the message source for the command.

getName() - Method in interface org.apache.geronimo.gshell.command.Alias

getName() - Method in interface org.apache.geronimo.gshell.command.CommandLocation

getName() - Method in interface org.apache.geronimo.gshell.command.Link

getNotification() - Method in class org.apache.geronimo.gshell.command.CommandResult

Returns the command notification.

getPath() - Method in interface org.apache.geronimo.gshell.command.CommandLocation

getResult() - Method in error org.apache.geronimo.gshell.notification.ResultNotification

getShell() - Method in interface org.apache.geronimo.gshell.shell.ShellContext

getTarget() - Method in interface org.apache.geronimo.gshell.command.Link

getValue() - Method in class org.apache.geronimo.gshell.command.CommandResult

The result value of a command execution.

getVariables() - Method in interface org.apache.geronimo.gshell.command.CommandContext

The variables for the command.

getVariables() - Method in interface org.apache.geronimo.gshell.shell.ShellContext

GROUP - Static variable in interface org.apache.geronimo.gshell.registry.CommandResolver

GROUP_NAME - Static variable in interface org.apache.geronimo.gshell.registry.CommandResolver

H

hasFailed() - Method in class org.apache.geronimo.gshell.command.CommandResult

True if the command failed with an exception.

hasNotified() - Method in class org.apache.geronimo.gshell.command.CommandResult

True if the command exited with a notification.

I

isCloaked(String) - Method in class org.apache.geronimo.gshell.command.Variables

isInteractive() - Method in interface org.apache.geronimo.gshell.shell.Shell

Check if the shell can be run interactivly.

isMutable(String) - Method in class org.apache.geronimo.gshell.command.Variables

isOpened() - Method in interface org.apache.geronimo.gshell.shell.Shell

L

Link - Interface in org.apache.geronimo.gshell.command

Provides a convenient way to register a link

N

names() - Method in class org.apache.geronimo.gshell.command.Variables

NoSuchAliasException - Exception in org.apache.geronimo.gshell.registry

Thrown to indicate that a requested named-alias was not found.

NoSuchAliasException(String) - Constructor for exception org.apache.geronimo.gshell.registry.NoSuchAliasException

NoSuchCommandException - Exception in org.apache.geronimo.gshell.registry

Thrown to indicate that a requested named-command was not found.

NoSuchCommandException(String) - Constructor for exception org.apache.geronimo.gshell.registry.NoSuchCommandException

Notification - Error in org.apache.geronimo.gshell.notification

Thrown to indicate a notification state.

Notification(String, Throwable) - Constructor for error org.apache.geronimo.gshell.notification.Notification

Notification(String) - Constructor for error org.apache.geronimo.gshell.notification.Notification

Notification(Throwable) - Constructor for error org.apache.geronimo.gshell.notification.Notification

Notification() - Constructor for error org.apache.geronimo.gshell.notification.Notification

O

org.apache.geronimo.gshell.command - package org.apache.geronimo.gshell.command

org.apache.geronimo.gshell.commandline - package org.apache.geronimo.gshell.commandline

org.apache.geronimo.gshell.notification - package org.apache.geronimo.gshell.notification

org.apache.geronimo.gshell.registry - package org.apache.geronimo.gshell.registry

org.apache.geronimo.gshell.shell - package org.apache.geronimo.gshell.shell

P

parent() - Method in class org.apache.geronimo.gshell.command.Variables

PATH - Static variable in interface org.apache.geronimo.gshell.registry.CommandResolver

PATH_SEPARATOR - Static variable in interface org.apache.geronimo.gshell.registry.CommandResolver

R

registerAlias(String, String) - Method in interface org.apache.geronimo.gshell.registry.AliasRegistry

registerCommand(Command) - Method in interface org.apache.geronimo.gshell.registry.CommandRegistry

removeAlias(String) - Method in interface org.apache.geronimo.gshell.registry.AliasRegistry

removeCommand(Command) - Method in interface org.apache.geronimo.gshell.registry.CommandRegistry

renderManual(PrintWriter) - Method in interface org.apache.geronimo.gshell.command.CommandDocumenter

Render the full command manual.

renderUsage(PrintWriter) - Method in interface org.apache.geronimo.gshell.command.CommandDocumenter

Render the command-line usage, as expected from --help.

resolveCommand(String, Variables) - Method in interface org.apache.geronimo.gshell.registry.CommandResolver

resolveCommands(String, Variables) - Method in interface org.apache.geronimo.gshell.registry.CommandResolver

ResultNotification - Error in org.apache.geronimo.gshell.notification

Thrown to indicate a command result state.

ResultNotification(Object) - Constructor for error org.apache.geronimo.gshell.notification.ResultNotification

ResultNotification(String, Object) - Constructor for error org.apache.geronimo.gshell.notification.ResultNotification

run(Object...) - Method in interface org.apache.geronimo.gshell.shell.Shell

Run the shell interactivly.

S

set(String, Object) - Method in class org.apache.geronimo.gshell.command.Variables

set(String, Object, boolean) - Method in class org.apache.geronimo.gshell.command.Variables

set(ShellContext) - Static method in class org.apache.geronimo.gshell.shell.ShellContextHolder

setCommand(Command) - Method in interface org.apache.geronimo.gshell.command.CommandAware

Shell - Interface in org.apache.geronimo.gshell.shell

Provides access to execute commands.

ShellContext - Interface in org.apache.geronimo.gshell.shell

Provides the execution context of a shell.

ShellContextHolder - Class in org.apache.geronimo.gshell.shell

ShellContext thread context holder.

ShellContextHolder() - Constructor for class org.apache.geronimo.gshell.shell.ShellContextHolder

ShellFactory - Interface in org.apache.geronimo.gshell.shell

Creates Shell instanes.

shift(Object[]) - Static method in class org.apache.geronimo.gshell.command.Arguments

shift(Object[], int) - Static method in class org.apache.geronimo.gshell.command.Arguments

T

toString() - Method in class org.apache.geronimo.gshell.command.CommandResult

toString() - Method in class org.apache.geronimo.gshell.command.Variables

toStringArray(Object[]) - Static method in class org.apache.geronimo.gshell.command.Arguments

U

unset(String) - Method in class org.apache.geronimo.gshell.command.Variables

V

valueOf(String) - Static method in enum org.apache.geronimo.gshell.command.CommandAction.Result

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.apache.geronimo.gshell.command.CommandAction.Result

Returns an array containing the constants of this enum type, in the order they're declared.

Variables - Class in org.apache.geronimo.gshell.command

Provides a nested-namespace for command variables.

Variables(Map<String, Object>, Variables) - Constructor for class org.apache.geronimo.gshell.command.Variables

Variables(Variables) - Constructor for class org.apache.geronimo.gshell.command.Variables

Variables(Map<String, Object>) - Constructor for class org.apache.geronimo.gshell.command.Variables

Variables() - Constructor for class org.apache.geronimo.gshell.command.Variables

Variables.ImmutableVariableException - Exception in org.apache.geronimo.gshell.command

Throw to indicate that a variable change was attempted but the variable was not muable.

Variables.ImmutableVariableException(String) - Constructor for exception org.apache.geronimo.gshell.command.Variables.ImmutableVariableException

A C D E F G H I L N O P R S T U V