Index (Aspectran Shell API Reference (5.8.2))

A B C D E F G H I J L M N O P Q R S T U V W

A

AbstractCommand - Class in com.aspectran.shell.command
AbstractCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.AbstractCommand
AbstractConsole - Class in com.aspectran.shell.console: The Abstract Class for Console I/O.
AbstractConsole(String) - Constructor for class com.aspectran.shell.console.AbstractConsole
AbstractShellService - Class in com.aspectran.shell.service: Abstract base class for ShellService implementations.
AbstractShellService() - Constructor for class com.aspectran.shell.service.AbstractShellService
adapt() - Method in class com.aspectran.shell.activity.ShellActivity
addArg(String) - Method in class com.aspectran.shell.command.option.ParsedOptions: Add left-over unrecognized option/argument.
addCommand(Class<? extends Command>) - Method in class com.aspectran.shell.command.CommandRegistry
addCommand(String...) - Method in class com.aspectran.shell.command.CommandRegistry
addOption(Option) - Method in class com.aspectran.shell.command.AbstractCommand
addOption(Option) - Method in class com.aspectran.shell.command.option.OptionGroup: Add the specified Option to this group.
addOption(Option) - Method in class com.aspectran.shell.command.option.Options: Adds an option instance.
addOption(Option) - Method in class com.aspectran.shell.command.option.ParsedOptions: Add an option.
addOption(String, boolean, String) - Method in class com.aspectran.shell.command.option.Options: Add an option that only contains a short-name.
addOption(String, String) - Method in class com.aspectran.shell.command.option.Options: Add an option that only contains a short name.
addOption(String, String, boolean, String) - Method in class com.aspectran.shell.command.option.Options: Add an option that contains a short-name and a long-name.
addOptionGroup(OptionGroup) - Method in class com.aspectran.shell.command.option.Options: Add the specified option group.
addRequiredOption(String, String, boolean, String) - Method in class com.aspectran.shell.command.option.Options: Add an option that contains a short-name and a long-name.
addValue(String) - Method in class com.aspectran.shell.command.option.Option: Adds the specified value to this Option.
afterContextLoaded() - Method in class com.aspectran.shell.service.AbstractShellService
AlreadySelectedException - Exception in com.aspectran.shell.command.option: Thrown when more than one option in an option group has been provided.
AlreadySelectedException(OptionGroup, Option) - Constructor for exception com.aspectran.shell.command.option.AlreadySelectedException: Construct a new AlreadySelectedException for the specified option group.
AlreadySelectedException(String) - Constructor for exception com.aspectran.shell.command.option.AlreadySelectedException: Construct a new AlreadySelectedException with the specified detail message.
AmbiguousOptionException - Exception in com.aspectran.shell.command.option: Exception thrown when an option can't be identified from a partial name.
AmbiguousOptionException(String, Collection<String>) - Constructor for exception com.aspectran.shell.command.option.AmbiguousOptionException: Constructs a new AmbiguousOptionException.
AnsiStyleHandler - Class in com.aspectran.shell.console: Created: 2017.
AnsiStyleHandler() - Constructor for class com.aspectran.shell.console.AnsiStyleHandler
APPEND_OUT - com.aspectran.shell.command.CommandLineRedirection.Operator: Appends command output to the end of a text file.
argName(String) - Method in class com.aspectran.shell.command.option.Option.Builder: Sets the display name for the argument value.
AspectranShell - Class in com.aspectran.shell: Main entry point for the Aspectran Shell.
AspectranShell() - Constructor for class com.aspectran.shell.AspectranShell
AspectranShellService - Class in com.aspectran.shell.service: The Class AspectranShellService.
attribute(String...) - Method in class com.aspectran.shell.console.AnsiStyleHandler

B

beforeContextDestroy() - Method in class com.aspectran.shell.service.AbstractShellService
BOOLEAN - com.aspectran.shell.command.option.OptionValueType
build() - Method in class com.aspectran.shell.command.option.Option.Builder: Constructs an Option with the values declared by this Option.Builder.
builder() - Static method in class com.aspectran.shell.command.option.Option: Returns a Option.Builder to create an Option using descriptive methods.
builder(String) - Static method in class com.aspectran.shell.command.option.Option: Returns a Option.Builder to create an Option using descriptive methods.

C

character(char) - Method in class com.aspectran.shell.console.AnsiStyleHandler
checkRequiredOptions() - Method in class com.aspectran.shell.command.option.DefaultOptionParser: Throws a MissingOptionException if all of the required options are not present.
ClearCommand - Class in com.aspectran.shell.command.builtin: Clear the terminal screen.
ClearCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtin.ClearCommand
clearScreen() - Method in interface com.aspectran.shell.console.Console
clearScreen() - Method in class com.aspectran.shell.console.DefaultConsole
clone() - Method in class com.aspectran.shell.command.option.Option: A rather odd clone method - due to incorrect code in 1.0 it is public and in 1.1 rather than throwing a CloneNotSupportedException it throws a RuntimeException so as to maintain backwards compat at the API level.
close() - Method in class com.aspectran.shell.console.MultiWriter
close() - Method in class com.aspectran.shell.console.UnclosablePrintWriter
com.aspectran.shell - package com.aspectran.shell: Provides an interactive shell that lets you use or control Aspectran directly from the command line.
com.aspectran.shell.activity - package com.aspectran.shell.activity: Contains a variant of the activity interface for command-line application.
com.aspectran.shell.adapter - package com.aspectran.shell.adapter: Contains a variant of the adapter interface for command-line application.
com.aspectran.shell.command - package com.aspectran.shell.command
com.aspectran.shell.command.builtin - package com.aspectran.shell.command.builtin
com.aspectran.shell.command.option - package com.aspectran.shell.command.option: A simple API for presenting, processing and validating a command line interface.
com.aspectran.shell.console - package com.aspectran.shell.console: A package for enhanced shell input and output.
com.aspectran.shell.service - package com.aspectran.shell.service: Contains a variant of the service interface for command-line application.
Command - Interface in com.aspectran.shell.command: The Command interface is there to allow Commander to delegate tasks.
Command.Descriptor - Interface in com.aspectran.shell.command: An interface that can be used to describe the the functionality of the command implementation.
CommandLineParser - Class in com.aspectran.shell.command: The Command Line Parser.
CommandLineRedirection - Class in com.aspectran.shell.command: Created: 2017.
CommandLineRedirection(CommandLineRedirection.Operator) - Constructor for class com.aspectran.shell.command.CommandLineRedirection
CommandLineRedirection.Operator - Enum in com.aspectran.shell.command: Command redirection operators.
CommandRegistry - Class in com.aspectran.shell.command: Created: 2017.
CommandRegistry(ShellService) - Constructor for class com.aspectran.shell.command.CommandRegistry
confirmQuit() - Method in interface com.aspectran.shell.console.Console
confirmQuit() - Method in class com.aspectran.shell.console.DefaultConsole
confirmRestart() - Method in interface com.aspectran.shell.console.Console
confirmRestart() - Method in class com.aspectran.shell.console.DefaultConsole
confirmRestart(String) - Method in interface com.aspectran.shell.console.Console
confirmRestart(String) - Method in class com.aspectran.shell.console.DefaultConsole
Console - Interface in com.aspectran.shell.console: The Interface for Console I/O.
ConsoleTerminatedException - Exception in com.aspectran.shell.command: This exception raised if a console is terminated.
ConsoleTerminatedException() - Constructor for exception com.aspectran.shell.command.ConsoleTerminatedException: Simple constructor.
ConsoleTerminatedException(String) - Constructor for exception com.aspectran.shell.command.ConsoleTerminatedException: Constructor to create exception with a message.
ConsoleTerminatedException(String, Throwable) - Constructor for exception com.aspectran.shell.command.ConsoleTerminatedException: Constructor to create exception to wrap another exception and pass a message.
ConsoleTerminatedException(Throwable) - Constructor for exception com.aspectran.shell.command.ConsoleTerminatedException: Constructor to create exception to wrap another exception.
create(File) - Static method in class com.aspectran.shell.service.AspectranShellService: Returns a new instance of AspectranShellService.
create(File, Console) - Static method in class com.aspectran.shell.service.AspectranShellService: Returns a new instance of AspectranShellService.
createPadding(int) - Static method in class com.aspectran.shell.command.option.OptionUtils: Return a String of padding of length len.

D

DEFAULT_COMMAND_PROMPT - Static variable in interface com.aspectran.shell.console.Console
DEFAULT_DESC_PAD - Static variable in class com.aspectran.shell.command.option.HelpFormatter: number of space characters to be prefixed to each description line
DEFAULT_LEFT_PAD - Static variable in class com.aspectran.shell.command.option.HelpFormatter: Default padding to the left of each line
DEFAULT_LONG_OPT_PREFIX - Static variable in class com.aspectran.shell.command.option.HelpFormatter: Default prefix for long Option
DEFAULT_OPT_PREFIX - Static variable in class com.aspectran.shell.command.option.HelpFormatter: Default prefix for shortOpts
DEFAULT_WIDTH - Static variable in class com.aspectran.shell.command.option.HelpFormatter: Default number of characters per line
DefaultConsole - Class in com.aspectran.shell.console: Console I/O implementation that supports System Console.
DefaultConsole() - Constructor for class com.aspectran.shell.console.DefaultConsole
DefaultConsole(String) - Constructor for class com.aspectran.shell.console.DefaultConsole
DefaultOptionParser - Class in com.aspectran.shell.command.option: The default command option parser.
DefaultOptionParser() - Constructor for class com.aspectran.shell.command.option.DefaultOptionParser: Creates a new DefaultParser instance with partial matching enabled.
DefaultOptionParser(boolean) - Constructor for class com.aspectran.shell.command.option.DefaultOptionParser: Create a new DefaultParser instance with the specified partial matching policy.
desc(String) - Method in class com.aspectran.shell.command.option.Option.Builder: Sets the description for this option.
DOUBLE - com.aspectran.shell.command.option.OptionValueType

E

equals(Object) - Method in class com.aspectran.shell.command.CommandLineRedirection
equals(Object) - Method in class com.aspectran.shell.command.option.Option
execute(CommandLineParser) - Method in class com.aspectran.shell.service.AspectranShellService
execute(CommandLineParser) - Method in interface com.aspectran.shell.service.ShellService: Executes a Shell Activity.
execute(String) - Method in class com.aspectran.shell.service.AspectranShellService
execute(String) - Method in interface com.aspectran.shell.service.ShellService: Executes a Shell Activity.
execute(String[]) - Method in class com.aspectran.shell.command.builtin.ClearCommand
execute(String[]) - Method in class com.aspectran.shell.command.builtin.HelpCommand
execute(String[]) - Method in class com.aspectran.shell.command.builtin.JettyCommand
execute(String[]) - Method in class com.aspectran.shell.command.builtin.PauseCommand
execute(String[]) - Method in class com.aspectran.shell.command.builtin.PBDecryptCommand
execute(String[]) - Method in class com.aspectran.shell.command.builtin.PBEncryptCommand
execute(String[]) - Method in class com.aspectran.shell.command.builtin.QuitCommand
execute(String[]) - Method in class com.aspectran.shell.command.builtin.RestartCommand
execute(String[]) - Method in class com.aspectran.shell.command.builtin.ResumeCommand
execute(String[]) - Method in class com.aspectran.shell.command.builtin.SysInfoCommand
execute(String[]) - Method in class com.aspectran.shell.command.builtin.TransletCommand
execute(String[]) - Method in class com.aspectran.shell.command.builtin.VerboseCommand
execute(String[]) - Method in interface com.aspectran.shell.command.Command: This method will be called as the starting point to execute the logic for the action mapped to this command.
extractParameters() - Method in class com.aspectran.shell.command.CommandLineParser

F

FILE - com.aspectran.shell.command.option.OptionValueType
findWrapPos(String, int, int) - Static method in class com.aspectran.shell.command.option.OptionUtils: Finds the next text wrap position after startPos for the text in text with the column width width.
FLOAT - com.aspectran.shell.command.option.OptionValueType
flush() - Method in interface com.aspectran.shell.console.Console
flush() - Method in class com.aspectran.shell.console.DefaultConsole
flush() - Method in class com.aspectran.shell.console.MultiWriter

G

getAllCommands() - Method in class com.aspectran.shell.command.CommandRegistry
getArgList() - Method in class com.aspectran.shell.command.option.ParsedOptions: Retrieve any left-over non-recognized options and arguments.
getArgName() - Method in class com.aspectran.shell.command.option.HelpFormatter: Returns the 'argName'.
getArgName() - Method in class com.aspectran.shell.command.option.Option: Gets the display name for the argument value.
getArgs() - Method in class com.aspectran.shell.command.CommandLineParser: Gets the command arguments.
getArgs() - Method in class com.aspectran.shell.command.option.Option: Returns the number of argument values this Option can take.
getArgs() - Method in class com.aspectran.shell.command.option.ParsedOptions: Retrieve any left-over non-recognized options and arguments.
getClassType() - Method in enum com.aspectran.shell.command.option.OptionValueType
getCommand(Class<? extends Command>) - Method in class com.aspectran.shell.command.CommandRegistry
getCommand(String) - Method in class com.aspectran.shell.command.CommandRegistry
getCommandName() - Method in class com.aspectran.shell.command.CommandLineParser: Gets the translet name.
getCommandPrompt() - Method in class com.aspectran.shell.console.AbstractConsole
getCommandPrompt() - Method in interface com.aspectran.shell.console.Console
getCommandRegistry() - Method in class com.aspectran.shell.command.AbstractCommand
getCommandRegistry() - Method in class com.aspectran.shell.service.AbstractShellService
getCommandRegistry() - Method in interface com.aspectran.shell.service.ShellService
getCommands() - Method in class com.aspectran.shell.service.AbstractShellService
getCommands() - Method in interface com.aspectran.shell.service.ShellService
getConsole() - Method in class com.aspectran.shell.command.AbstractCommand
getConsole() - Method in class com.aspectran.shell.service.AbstractShellService
getConsole() - Method in interface com.aspectran.shell.service.ShellService: Returns the console.
getDefaultPath() - Method in class com.aspectran.shell.console.AbstractConsole
getDefaultPath() - Method in interface com.aspectran.shell.console.Console
getDescPadding() - Method in class com.aspectran.shell.command.option.HelpFormatter: Returns the 'descPadding'.
getDescription() - Method in interface com.aspectran.shell.command.Command.Descriptor: This method should return a descriptive text about the command it is attached to.
getDescription() - Method in class com.aspectran.shell.command.option.Option: Retrieve the self-documenting description of this Option
getDescriptor() - Method in class com.aspectran.shell.command.builtin.ClearCommand
getDescriptor() - Method in class com.aspectran.shell.command.builtin.HelpCommand
getDescriptor() - Method in class com.aspectran.shell.command.builtin.JettyCommand
getDescriptor() - Method in class com.aspectran.shell.command.builtin.PauseCommand
getDescriptor() - Method in class com.aspectran.shell.command.builtin.PBDecryptCommand
getDescriptor() - Method in class com.aspectran.shell.command.builtin.PBEncryptCommand
getDescriptor() - Method in class com.aspectran.shell.command.builtin.QuitCommand
getDescriptor() - Method in class com.aspectran.shell.command.builtin.RestartCommand
getDescriptor() - Method in class com.aspectran.shell.command.builtin.ResumeCommand
getDescriptor() - Method in class com.aspectran.shell.command.builtin.SysInfoCommand
getDescriptor() - Method in class com.aspectran.shell.command.builtin.TransletCommand
getDescriptor() - Method in class com.aspectran.shell.command.builtin.VerboseCommand
getDescriptor() - Method in interface com.aspectran.shell.command.Command: This method returns an instance of Command.Descriptor.
getEncoding() - Method in interface com.aspectran.shell.console.Console
getEncoding() - Method in class com.aspectran.shell.console.DefaultConsole
getGreetings() - Method in class com.aspectran.shell.service.AbstractShellService
getGreetings() - Method in interface com.aspectran.shell.service.ShellService
getId() - Method in class com.aspectran.shell.command.option.Option: Returns the id of this Option.
getKey() - Method in class com.aspectran.shell.command.option.Option: Returns the 'unique' Option identifier.
getLeftPadding() - Method in class com.aspectran.shell.command.option.HelpFormatter: Returns the 'leftPadding'.
getLongOpt() - Method in class com.aspectran.shell.command.option.Option: Retrieve the long name of this Option.
getLongOptPrefix() - Method in class com.aspectran.shell.command.option.HelpFormatter: Returns the 'longOptPrefix'.
getLongOptSeparator() - Method in class com.aspectran.shell.command.option.HelpFormatter: Returns the separator displayed between a long option and its value.
getMatchingOptions() - Method in exception com.aspectran.shell.command.option.AmbiguousOptionException: Returns the options matching the partial name.
getMatchingOptions(String) - Method in class com.aspectran.shell.command.option.Options: Returns the options with a long name starting with the name specified.
getMissingOptions() - Method in exception com.aspectran.shell.command.option.MissingOptionException: Returns the list of options or option groups missing in the command line parsed.
getName() - Method in interface com.aspectran.shell.command.Command.Descriptor: Implementation of this method should return a simple string (with no spaces) that identifies the action mapped to this command.
getNames() - Method in class com.aspectran.shell.command.option.OptionGroup
getNamespace() - Method in interface com.aspectran.shell.command.Command.Descriptor: The purpose of the namespace is to provide an identifier to group commands without relying on class name or other convoluted approaches to group commands.
getNewLine() - Method in class com.aspectran.shell.command.option.HelpFormatter: Returns the 'newLine'.
getOperand() - Method in class com.aspectran.shell.command.CommandLineRedirection
getOperator() - Method in class com.aspectran.shell.command.CommandLineRedirection
getOpt() - Method in class com.aspectran.shell.command.option.Option: Retrieve the name of this Option.
getOption() - Method in exception com.aspectran.shell.command.option.AlreadySelectedException: Returns the option that was added to the group and triggered the exception.
getOption() - Method in exception com.aspectran.shell.command.option.MissingArgumentException: Return the option requiring an argument that wasn't provided on the command line.
getOption() - Method in exception com.aspectran.shell.command.option.UnrecognizedOptionException: Returns the unrecognized option.
getOption(String) - Method in class com.aspectran.shell.command.option.Options: Retrieve the Option matching the long or short name specified.
getOptionComparator() - Method in class com.aspectran.shell.command.option.HelpFormatter: Comparator used to sort the options when they output in help text.
getOptionGroup() - Method in exception com.aspectran.shell.command.option.AlreadySelectedException: Returns the option group where another option has been selected.
getOptionGroup(Option) - Method in class com.aspectran.shell.command.option.Options: Returns the OptionGroup the opt belongs to.
getOptions() - Method in class com.aspectran.shell.command.AbstractCommand
getOptions() - Method in interface com.aspectran.shell.command.Command.Descriptor: Use this method is to provide a map of the command arguments.
getOptions() - Method in class com.aspectran.shell.command.option.OptionGroup
getOptions() - Method in class com.aspectran.shell.command.option.Options: Retrieve a read-only list of options in this set.
getOptions() - Method in class com.aspectran.shell.command.option.ParsedOptions: Returns an array of the processed Options.
getOptPrefix() - Method in class com.aspectran.shell.command.option.HelpFormatter: Returns the 'optPrefix'.
getOutput() - Method in interface com.aspectran.shell.console.Console
getOutput() - Method in class com.aspectran.shell.console.DefaultConsole
getParser() - Method in class com.aspectran.shell.command.AbstractCommand
getParser() - Method in class com.aspectran.shell.command.CommandRegistry
getProperties(Option) - Method in class com.aspectran.shell.command.option.ParsedOptions: Retrieve the map of values associated to the option.
getProperties(String) - Method in class com.aspectran.shell.command.option.ParsedOptions: Retrieve the map of values associated to the option.
getRedirectionList() - Method in class com.aspectran.shell.command.CommandLineParser
getRedirectionWriters(Console) - Method in class com.aspectran.shell.command.CommandLineParser
getRequestMethod() - Method in class com.aspectran.shell.command.CommandLineParser: Gets the request method.
getRequiredOptions() - Method in class com.aspectran.shell.command.option.Options: Returns the required options.
getSelected() - Method in class com.aspectran.shell.command.option.OptionGroup: Returns the selected option name.
getService() - Method in class com.aspectran.shell.command.AbstractCommand
getService() - Method in class com.aspectran.shell.command.CommandRegistry
getSyntaxPrefix() - Method in class com.aspectran.shell.command.option.HelpFormatter: Returns the 'syntaxPrefix'.
getTypedValue(char) - Method in class com.aspectran.shell.command.option.ParsedOptions: Return a version of this Option converted to a particular type.
getTypedValue(Option) - Method in class com.aspectran.shell.command.option.ParsedOptions: Return a version of this Option converted to a particular type.
getTypedValue(String) - Method in class com.aspectran.shell.command.option.ParsedOptions: Return a version of this Option converted to a particular type.
getUnclosableWriter() - Method in class com.aspectran.shell.console.AbstractConsole
getUnclosableWriter() - Method in interface com.aspectran.shell.console.Console
getUsage() - Method in interface com.aspectran.shell.command.Command.Descriptor: Implementation of this method should return helpful hint on how to use the associated command and further description of options that are supported by the command.
getValue() - Method in class com.aspectran.shell.command.option.Option: Returns the specified value of this Option or null if there is no value.
getValue(char) - Method in class com.aspectran.shell.command.option.ParsedOptions: Retrieve the first argument, if any, of this option.
getValue(char, String) - Method in class com.aspectran.shell.command.option.ParsedOptions: Retrieve the argument, if any, of an option.
getValue(int) - Method in class com.aspectran.shell.command.option.Option: Returns the specified value of this Option or null if there is no value.
getValue(Option) - Method in class com.aspectran.shell.command.option.ParsedOptions: Retrieve the first argument, if any, of this option.
getValue(Option, String) - Method in class com.aspectran.shell.command.option.ParsedOptions: Retrieve the first argument, if any, of an option.
getValue(String) - Method in class com.aspectran.shell.command.option.Option: Returns the value/first value of this Option or the defaultValue if there is no value.
getValue(String) - Method in class com.aspectran.shell.command.option.ParsedOptions: Retrieve the first argument, if any, of this option.
getValue(String, String) - Method in class com.aspectran.shell.command.option.ParsedOptions: Retrieve the first argument, if any, of an option.
getValues() - Method in class com.aspectran.shell.command.option.Option: Return the values of this Option as a String array or null if there are no values.
getValues(char) - Method in class com.aspectran.shell.command.option.ParsedOptions: Retrieves the array of values, if any, of an option.
getValues(Option) - Method in class com.aspectran.shell.command.option.ParsedOptions: Retrieves the array of values, if any, of an option.
getValues(String) - Method in class com.aspectran.shell.command.option.ParsedOptions: Retrieves the array of values, if any, of an option.
getValueSeparator() - Method in class com.aspectran.shell.command.option.Option: Returns the value separator character.
getValuesList() - Method in class com.aspectran.shell.command.option.Option: Returns the values of this Option as a List or null if there are no values.
getValueType() - Method in class com.aspectran.shell.command.option.Option: Retrieve the type of this Option.
getWidth() - Method in class com.aspectran.shell.command.option.HelpFormatter: Returns the 'width'.
getWriter() - Method in interface com.aspectran.shell.console.Console
getWriter() - Method in class com.aspectran.shell.console.DefaultConsole

H

handle(CharSequence) - Method in class com.aspectran.shell.console.AnsiStyleHandler
handleConcatenatedOptions(String) - Method in class com.aspectran.shell.command.option.DefaultOptionParser: Breaks token into its constituent parts using the following algorithm.
hasArg() - Method in class com.aspectran.shell.command.option.Option.Builder: Indicates that the Option will require an argument.
hasArg() - Method in class com.aspectran.shell.command.option.Option: Query to see if this Option requires an argument.
hasArg(boolean) - Method in class com.aspectran.shell.command.option.Option.Builder: Indicates if the Option has an argument or not.
hasArgName() - Method in class com.aspectran.shell.command.option.Option: Returns whether the display name for the argument value has been set.
hasArgs() - Method in class com.aspectran.shell.command.option.Option.Builder: Indicates that the Option can have unlimited argument values.
hasArgs() - Method in class com.aspectran.shell.command.option.Option: Query to see if this Option can take many values.
hasArgs() - Method in class com.aspectran.shell.command.option.ParsedOptions: Checks if non-recognized options or arguments exists.
hashCode() - Method in class com.aspectran.shell.command.CommandLineRedirection
hashCode() - Method in class com.aspectran.shell.command.option.Option
hasLongOpt() - Method in class com.aspectran.shell.command.option.Option: Query to see if this Option has a long name.
hasLongOption(String) - Method in class com.aspectran.shell.command.option.Options: Returns whether the named Option is a member of this Options.
hasOption(char) - Method in class com.aspectran.shell.command.option.ParsedOptions: Query to see if an option has been set.
hasOption(Option) - Method in class com.aspectran.shell.command.option.ParsedOptions: Query to see if an option has been set.
hasOption(String) - Method in class com.aspectran.shell.command.option.Options: Returns whether the named Option is a member of this Options.
hasOption(String) - Method in class com.aspectran.shell.command.option.ParsedOptions: Query to see if an option has been set.
hasOptionalArg() - Method in class com.aspectran.shell.command.option.Option: Returns whether this Option can have an optional argument.
hasOptions() - Method in class com.aspectran.shell.command.option.ParsedOptions: Checks if options exists.
hasParameters() - Method in class com.aspectran.shell.command.CommandLineParser
hasShortOption(String) - Method in class com.aspectran.shell.command.option.Options: Returns whether the named Option is a member of this Options.
hasValueSeparator() - Method in class com.aspectran.shell.command.option.Option: Return whether this Option has specified a value separator.
HelpCommand - Class in com.aspectran.shell.command.builtin: Display information about builtin commands.
HelpCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtin.HelpCommand
HelpFormatter - Class in com.aspectran.shell.command.option: A formatter of help messages for command line options.
HelpFormatter(Console) - Constructor for class com.aspectran.shell.command.option.HelpFormatter: Creates a help formatter.

I

INT - com.aspectran.shell.command.option.OptionValueType
isBusy() - Method in class com.aspectran.shell.service.AbstractShellService
isEmpty() - Method in class com.aspectran.shell.command.option.Options: Returns true if no options have been added.
isExposable(String) - Method in class com.aspectran.shell.service.AbstractShellService
isExposable(String) - Method in interface com.aspectran.shell.service.ShellService: Checks whether the Translet can be exposed.
isParseArgs() - Method in class com.aspectran.shell.command.CommandLineParser
isReading() - Method in interface com.aspectran.shell.console.Console
isReading() - Method in class com.aspectran.shell.console.DefaultConsole
isRequired() - Method in class com.aspectran.shell.command.option.Option: Query to see if this Option is mandatory
isRequired() - Method in class com.aspectran.shell.command.option.OptionGroup: Returns whether this option group is required.
isVerbose() - Method in class com.aspectran.shell.service.AbstractShellService: Tests if the verbose mode is enabled.
isVerbose() - Method in interface com.aspectran.shell.service.ShellService: Tests if the verbose mode is enabled.
iterator() - Method in class com.aspectran.shell.command.option.ParsedOptions: Returns an iterator over the Option members of ParsedOptions.

J

JettyCommand - Class in com.aspectran.shell.command.builtin: Use the command 'jetty' to control the Jetty Server.
JettyCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtin.JettyCommand

L

LONG - com.aspectran.shell.command.option.OptionValueType
longOpt(String) - Method in class com.aspectran.shell.command.option.Option.Builder: Sets the long name of the Option.

M

main(String[]) - Static method in class com.aspectran.shell.AspectranShell
MissingArgumentException - Exception in com.aspectran.shell.command.option: Thrown when an option requiring an argument is not provided with an argument.
MissingArgumentException(Option) - Constructor for exception com.aspectran.shell.command.option.MissingArgumentException: Construct a new MissingArgumentException with the specified detail message.
MissingArgumentException(String) - Constructor for exception com.aspectran.shell.command.option.MissingArgumentException: Construct a new MissingArgumentException with the specified detail message.
MissingOptionException - Exception in com.aspectran.shell.command.option: Thrown when a required option has not been provided.
MissingOptionException(String) - Constructor for exception com.aspectran.shell.command.option.MissingOptionException: Construct a new MissingSelectedException with the specified detail message.
MissingOptionException(List<?>) - Constructor for exception com.aspectran.shell.command.option.MissingOptionException: Constructs a new MissingSelectedException with the specified list of missing options.
MultiWriter - Class in com.aspectran.shell.console: The writer that handles multiple writers.
MultiWriter(Writer[]) - Constructor for class com.aspectran.shell.console.MultiWriter

N

newActivity() - Method in class com.aspectran.shell.activity.ShellActivity
newSessionAdapter() - Method in class com.aspectran.shell.service.AbstractShellService
newSessionAdapter() - Method in interface com.aspectran.shell.service.ShellService: Creates a new session adapter for the shell service and returns.
numberOfArgs(int) - Method in class com.aspectran.shell.command.option.Option.Builder: Sets the number of argument values the Option can take.

O

offStyle() - Method in interface com.aspectran.shell.console.Console
offStyle() - Method in class com.aspectran.shell.console.DefaultConsole
Option - Class in com.aspectran.shell.command.option: Describes a single command-line option.
Option(String, boolean, String) - Constructor for class com.aspectran.shell.command.option.Option: Creates an Option using the specified parameters.
Option(String, String) - Constructor for class com.aspectran.shell.command.option.Option: Creates an Option using the specified parameters.
Option(String, String, boolean, String) - Constructor for class com.aspectran.shell.command.option.Option: Creates an Option using the specified parameters.
Option.Builder - Class in com.aspectran.shell.command.option: A nested builder class to create Option instances using descriptive methods.
optionalArg(boolean) - Method in class com.aspectran.shell.command.option.Option.Builder: Sets whether the Option can have an optional argument.
optionComparator - Variable in class com.aspectran.shell.command.option.HelpFormatter: Comparator used to sort the options when they output in help text.
OptionGroup - Class in com.aspectran.shell.command.option: A group of mutually exclusive options.
OptionGroup() - Constructor for class com.aspectran.shell.command.option.OptionGroup
OptionParser - Interface in com.aspectran.shell.command.option: A class that implements this OptionParser interface can parse a String array according to the Options specified and return a ParsedOptions.
OptionParserException - Exception in com.aspectran.shell.command.option: Base for Exceptions thrown during parsing of a command-line.
OptionParserException(String) - Constructor for exception com.aspectran.shell.command.option.OptionParserException: Construct a new OptionParseException with the specified detail message.
options - Variable in class com.aspectran.shell.command.AbstractCommand
Options - Class in com.aspectran.shell.command.option: Main entry-point into the library.
Options() - Constructor for class com.aspectran.shell.command.option.Options
OptionUtils - Class in com.aspectran.shell.command.option: Contains useful helper methods for classes within this package.
OptionUtils() - Constructor for class com.aspectran.shell.command.option.OptionUtils
OptionValueType - Enum in com.aspectran.shell.command.option: Supported Option value types.
OVERWRITE_OUT - com.aspectran.shell.command.CommandLineRedirection.Operator: Writes the command output to a text file.

P

parse(Options, String[]) - Method in class com.aspectran.shell.command.option.DefaultOptionParser
parse(Options, String[]) - Method in interface com.aspectran.shell.command.option.OptionParser: Parse the arguments according to the specified options.
parse(Options, String[], boolean) - Method in class com.aspectran.shell.command.option.DefaultOptionParser
parse(Options, String[], boolean) - Method in interface com.aspectran.shell.command.option.OptionParser: Parse the arguments according to the specified options.
parse(Options, String[], Properties) - Method in class com.aspectran.shell.command.option.DefaultOptionParser: Parse the arguments according to the specified options and properties.
parse(Options, String[], Properties) - Method in interface com.aspectran.shell.command.option.OptionParser: Parse the arguments according to the specified options and properties.
parse(Options, String[], Properties, boolean) - Method in class com.aspectran.shell.command.option.DefaultOptionParser: Parse the arguments according to the specified options and properties.
parse(Options, String[], Properties, boolean) - Method in interface com.aspectran.shell.command.option.OptionParser: Parse the arguments according to the specified options and properties.
parse(String) - Static method in class com.aspectran.shell.command.CommandLineParser: Returns the command line parser.
parse(String[]) - Method in class com.aspectran.shell.command.AbstractCommand
parse(String, boolean) - Static method in class com.aspectran.shell.command.CommandLineParser
ParsedOptions - Class in com.aspectran.shell.command.option: Represents list of arguments parsed against a Options descriptor.
ParsedOptions() - Constructor for class com.aspectran.shell.command.option.ParsedOptions: Creates a command line.
parseRequest() - Method in class com.aspectran.shell.activity.ShellActivity
PauseCommand - Class in com.aspectran.shell.command.builtin: Pause the Aspectran Shell.
PauseCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtin.PauseCommand
PBDecryptCommand - Class in com.aspectran.shell.command.builtin: Decrypts the input string using the encryption password.
PBDecryptCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtin.PBDecryptCommand
PBEncryptCommand - Class in com.aspectran.shell.command.builtin: Encrypts the input string using the encryption password.
PBEncryptCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtin.PBEncryptCommand
perform() - Method in class com.aspectran.shell.command.ShellCommander
printGreetings() - Method in class com.aspectran.shell.service.AbstractShellService
printGreetings() - Method in interface com.aspectran.shell.service.ShellService: Prints welcome message.
printHelp() - Method in class com.aspectran.shell.service.AbstractShellService
printHelp() - Method in interface com.aspectran.shell.service.ShellService: Prints help information.
printHelp(int, String, String, Options, int, int, String) - Method in class com.aspectran.shell.command.option.HelpFormatter: Print the help for options with the specified command line syntax.
printHelp(int, String, String, Options, int, int, String, boolean) - Method in class com.aspectran.shell.command.option.HelpFormatter: Print the help for options with the specified command line syntax.
printHelp(int, String, String, Options, String) - Method in class com.aspectran.shell.command.option.HelpFormatter: Print the help for options with the specified command line syntax.
printHelp(int, String, String, Options, String, boolean) - Method in class com.aspectran.shell.command.option.HelpFormatter: Print the help for options with the specified command line syntax.
printHelp(String, Options) - Method in class com.aspectran.shell.command.option.HelpFormatter: Print the help for options with the specified command line syntax.
printHelp(String, Options, boolean) - Method in class com.aspectran.shell.command.option.HelpFormatter: Print the help for options with the specified command line syntax.
printHelp(String, String, Options, String) - Method in class com.aspectran.shell.command.option.HelpFormatter: Print the help for options with the specified command line syntax.
printHelp(String, String, Options, String, boolean) - Method in class com.aspectran.shell.command.option.HelpFormatter: Print the help for options with the specified command line syntax.
printOptions(int, Options, int, int) - Method in class com.aspectran.shell.command.option.HelpFormatter: Print the help for the specified Options to the specified writer, using the specified width, left padding and description padding.
printUsage() - Method in class com.aspectran.shell.command.AbstractCommand
printUsage() - Method in interface com.aspectran.shell.command.Command: Prints the usage statement for the specified command.
printUsage(int, String) - Method in class com.aspectran.shell.command.option.HelpFormatter: Print the cmdLineSyntax to the specified writer, using the specified width.
printUsage(int, String, Options) - Method in class com.aspectran.shell.command.option.HelpFormatter: Prints the usage statement for the specified command.
printUsage(Console) - Method in class com.aspectran.shell.command.AbstractCommand
printUsage(Console) - Method in interface com.aspectran.shell.command.Command: Prints the usage statement for the specified command.
printWrapped(int, int, String) - Method in class com.aspectran.shell.command.option.HelpFormatter: Print the specified text to the specified PrintWriter.
printWrapped(int, String) - Method in class com.aspectran.shell.command.option.HelpFormatter: Print the specified text to the specified PrintWriter.

Q

QuitCommand - Class in com.aspectran.shell.command.builtin: Releases all resources and exits this application.
QuitCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtin.QuitCommand

R

readCommandLine() - Method in interface com.aspectran.shell.console.Console
readCommandLine() - Method in class com.aspectran.shell.console.DefaultConsole
readCommandLine(String) - Method in interface com.aspectran.shell.console.Console
readCommandLine(String) - Method in class com.aspectran.shell.console.DefaultConsole
readLine() - Method in interface com.aspectran.shell.console.Console
readLine() - Method in class com.aspectran.shell.console.DefaultConsole
readLine(String) - Method in interface com.aspectran.shell.console.Console
readLine(String) - Method in class com.aspectran.shell.console.DefaultConsole
readLine(String, Object...) - Method in interface com.aspectran.shell.console.Console
readLine(String, Object...) - Method in class com.aspectran.shell.console.DefaultConsole
readPassword() - Method in interface com.aspectran.shell.console.Console
readPassword() - Method in class com.aspectran.shell.console.DefaultConsole
readPassword(String) - Method in interface com.aspectran.shell.console.Console
readPassword(String) - Method in class com.aspectran.shell.console.DefaultConsole
readPassword(String, Object...) - Method in interface com.aspectran.shell.console.Console
readPassword(String, Object...) - Method in class com.aspectran.shell.console.DefaultConsole
release() - Method in class com.aspectran.shell.service.AspectranShellService
release() - Method in interface com.aspectran.shell.service.ShellService: Stop the service and release all allocated resources.
renderOptions(StringBuilder, int, Options, int, int) - Method in class com.aspectran.shell.command.option.HelpFormatter: Render the specified Options and return the rendered Options in a StringBuilder.
renderWrappedText(StringBuilder, int, int, String) - Method in class com.aspectran.shell.command.option.HelpFormatter: Render the specified text and return the rendered Options in a StringBuilder.
required() - Method in class com.aspectran.shell.command.option.Option.Builder: Marks this Option as required.
required(boolean) - Method in class com.aspectran.shell.command.option.Option.Builder: Sets whether the Option is mandatory.
resolve(String) - Static method in enum com.aspectran.shell.command.option.OptionValueType: Returns an OptionValueType with a value represented by the specified String.
restart() - Method in class com.aspectran.shell.service.AbstractShellService
restart(String) - Method in class com.aspectran.shell.service.AbstractShellService
RestartCommand - Class in com.aspectran.shell.command.builtin: Restarts the Aspectran Shell.
RestartCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtin.RestartCommand
ResumeCommand - Class in com.aspectran.shell.command.builtin: Resume the Aspectran Shell.
ResumeCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtin.ResumeCommand
rtrim(String) - Static method in class com.aspectran.shell.command.option.OptionUtils: Remove the trailing whitespace from the specified String.
run(File) - Static method in interface com.aspectran.shell.service.ShellService: Run the Shell Service, creating and starting a new ShellService.
run(File, Console) - Static method in interface com.aspectran.shell.service.ShellService: Run the Shell Service, creating and starting a new ShellService.

S

serialize(List<CommandLineRedirection>) - Static method in class com.aspectran.shell.command.CommandLineParser
setArgName(String) - Method in class com.aspectran.shell.command.option.HelpFormatter: Sets the 'argName'.
setArgName(String) - Method in class com.aspectran.shell.command.option.Option: Sets the display name for the argument value.
setArgs(int) - Method in class com.aspectran.shell.command.option.Option: Sets the number of argument values this Option can take.
setCommandPrompt(String) - Method in class com.aspectran.shell.console.AbstractConsole
setCommandPrompt(String) - Method in interface com.aspectran.shell.console.Console
setCommands(String[]) - Method in class com.aspectran.shell.service.AbstractShellService
setConsole(Console) - Method in class com.aspectran.shell.service.AbstractShellService
setDescPadding(int) - Method in class com.aspectran.shell.command.option.HelpFormatter: Sets the 'descPadding'.
setDescription(String) - Method in class com.aspectran.shell.command.option.Option: Sets the self-documenting description of this Option
setGreetings(String) - Method in class com.aspectran.shell.service.AbstractShellService
setGreetings(String) - Method in interface com.aspectran.shell.service.ShellService
setLeftPadding(int) - Method in class com.aspectran.shell.command.option.HelpFormatter: Sets the 'leftPadding'.
setLongOpt(String) - Method in class com.aspectran.shell.command.option.Option: Sets the long name of this Option.
setLongOptPrefix(String) - Method in class com.aspectran.shell.command.option.HelpFormatter: Sets the 'longOptPrefix'.
setLongOptSeparator(String) - Method in class com.aspectran.shell.command.option.HelpFormatter: Set the separator displayed between a long option and its value.
setNewLine(String) - Method in class com.aspectran.shell.command.option.HelpFormatter: Sets the 'newLine'.
setOperand(String) - Method in class com.aspectran.shell.command.CommandLineRedirection
setOptionalArg(boolean) - Method in class com.aspectran.shell.command.option.Option: Sets whether this Option can have an optional argument.
setOptionComparator(Comparator<Option>) - Method in class com.aspectran.shell.command.option.HelpFormatter: Set the comparator used to sort the options when they output in help text.
setOptPrefix(String) - Method in class com.aspectran.shell.command.option.HelpFormatter: Sets the 'optPrefix'.
setParameterMap(ParameterMap) - Method in class com.aspectran.shell.activity.ShellActivity
setProcedural(boolean) - Method in class com.aspectran.shell.activity.ShellActivity
setRedirectionWriters(Writer[]) - Method in class com.aspectran.shell.activity.ShellActivity
setRequired(boolean) - Method in class com.aspectran.shell.command.option.Option: Sets whether this Option is mandatory.
setRequired(boolean) - Method in class com.aspectran.shell.command.option.OptionGroup
setSelected(Option) - Method in class com.aspectran.shell.command.option.OptionGroup: Set the selected option of this group to name.
setService(ShellService) - Method in class com.aspectran.shell.console.AbstractConsole
setService(ShellService) - Method in interface com.aspectran.shell.console.Console
setStyle(String...) - Method in interface com.aspectran.shell.console.Console
setStyle(String...) - Method in class com.aspectran.shell.console.DefaultConsole
setSyntaxPrefix(String) - Method in class com.aspectran.shell.command.option.HelpFormatter: Sets the 'syntaxPrefix'.
setValueSeparator(char) - Method in class com.aspectran.shell.command.option.Option: Sets the value separator.
setValueType(OptionValueType) - Method in class com.aspectran.shell.command.option.Option: Sets the type of this Option.
setVerbose(boolean) - Method in class com.aspectran.shell.service.AbstractShellService: Enables or disables the verbose mode.
setVerbose(boolean) - Method in interface com.aspectran.shell.service.ShellService: Enables or disables the verbose mode.
setWidth(int) - Method in class com.aspectran.shell.command.option.HelpFormatter: Sets the 'width'.
ShellActivity - Class in com.aspectran.shell.activity: The Class ShellActivity.
ShellActivity(ShellService) - Constructor for class com.aspectran.shell.activity.ShellActivity: Instantiates a new ShellActivity.
ShellApplicationAdapter - Class in com.aspectran.shell.adapter: The Class ShellApplicationAdapter.
ShellApplicationAdapter() - Constructor for class com.aspectran.shell.adapter.ShellApplicationAdapter: Instantiates a new ShellApplicationAdapter.
ShellCommander - Class in com.aspectran.shell.command: The Shell Command Handler.
ShellCommander(ShellService) - Constructor for class com.aspectran.shell.command.ShellCommander
ShellRequestAdapter - Class in com.aspectran.shell.adapter: The Class ShellRequestAdapter.
ShellRequestAdapter() - Constructor for class com.aspectran.shell.adapter.ShellRequestAdapter: Instantiates a new ShellRequestAdapter.
ShellResponseAdapter - Class in com.aspectran.shell.adapter: The Class ShellResponseAdapter.
ShellResponseAdapter(Writer) - Constructor for class com.aspectran.shell.adapter.ShellResponseAdapter: Instantiates a new ShellResponseAdapter.
ShellService - Interface in com.aspectran.shell.service: The Interface ShellService.
ShellSessionAdapter - Class in com.aspectran.shell.adapter: The Class ShellSessionAdapter.
ShellSessionAdapter(SessionAgent) - Constructor for class com.aspectran.shell.adapter.ShellSessionAdapter: Instantiates a new ShellSessionAdapter.
splitCommandLine(String) - Static method in class com.aspectran.shell.command.CommandLineParser
STRING - com.aspectran.shell.command.option.OptionValueType
SysInfoCommand - Class in com.aspectran.shell.command.builtin: Displays current JVM runtime information.
SysInfoCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtin.SysInfoCommand

T

toString() - Method in enum com.aspectran.shell.command.CommandLineRedirection.Operator
toString() - Method in class com.aspectran.shell.command.CommandLineRedirection
toString() - Method in class com.aspectran.shell.command.option.Option: Dump state, suitable for debugging.
toString() - Method in class com.aspectran.shell.command.option.OptionGroup: Returns the stringified version of this OptionGroup.
toString() - Method in class com.aspectran.shell.command.option.Options: Dump state, suitable for debugging.
toString() - Method in enum com.aspectran.shell.command.option.OptionValueType
TransletCommand - Class in com.aspectran.shell.command.builtin
TransletCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtin.TransletCommand

U

UnclosablePrintWriter - Class in com.aspectran.shell.console: The Class UnclosablePrintWriter.
UnclosablePrintWriter(OutputStream, String) - Constructor for class com.aspectran.shell.console.UnclosablePrintWriter
UnclosablePrintWriter(Writer) - Constructor for class com.aspectran.shell.console.UnclosablePrintWriter
UNINITIALIZED - Static variable in class com.aspectran.shell.command.option.Option: Constant that specifies the number of argument values has not been specified
UNLIMITED_VALUES - Static variable in class com.aspectran.shell.command.option.Option: Constant that specifies the number of argument values is infinite
UnrecognizedOptionException - Exception in com.aspectran.shell.command.option: Exception thrown during parsing signalling an unrecognized option was seen.
UnrecognizedOptionException(String) - Constructor for exception com.aspectran.shell.command.option.UnrecognizedOptionException: Construct a new UnrecognizedArgumentException with the specified detail message.
UnrecognizedOptionException(String, String) - Constructor for exception com.aspectran.shell.command.option.UnrecognizedOptionException: Construct a new UnrecognizedArgumentException with the specified option and detail message.

V

valueOf(String) - Static method in enum com.aspectran.shell.command.CommandLineRedirection.Operator: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.aspectran.shell.command.option.OptionValueType: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.aspectran.shell.command.CommandLineRedirection.Operator: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.aspectran.shell.command.option.OptionValueType: Returns an array containing the constants of this enum type, in the order they are declared.
valueSeparator() - Method in class com.aspectran.shell.command.option.Option.Builder: The Option will use '=' as a means to separate argument value.
valueSeparator(char) - Method in class com.aspectran.shell.command.option.Option.Builder: The Option will use sep as a means to separate argument values.
valueType(OptionValueType) - Method in class com.aspectran.shell.command.option.Option.Builder: Sets the type of the Option.
VerboseCommand - Class in com.aspectran.shell.command.builtin: Turns verbose mode on or off.
VerboseCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtin.VerboseCommand

W

write(char[], int, int) - Method in class com.aspectran.shell.console.MultiWriter
write(String) - Method in interface com.aspectran.shell.console.Console
write(String) - Method in class com.aspectran.shell.console.DefaultConsole
write(String, Object...) - Method in interface com.aspectran.shell.console.Console
write(String, Object...) - Method in class com.aspectran.shell.console.DefaultConsole
writeLine() - Method in interface com.aspectran.shell.console.Console
writeLine() - Method in class com.aspectran.shell.console.DefaultConsole
writeLine(String) - Method in interface com.aspectran.shell.console.Console
writeLine(String) - Method in class com.aspectran.shell.console.DefaultConsole
writeLine(String, Object...) - Method in interface com.aspectran.shell.console.Console
writeLine(String, Object...) - Method in class com.aspectran.shell.console.DefaultConsole

A B C D E F G H I J L M N O P Q R S T U V W