A B C D E F G H I J L M N O P Q R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractCommand - Class in com.aspectran.shell.command
- AbstractCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.AbstractCommand
- AbstractCommandLine - Class in com.aspectran.shell.command
- AbstractCommandLine(CommandLineParser) - Constructor for class com.aspectran.shell.command.AbstractCommandLine
- 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
ShellServiceimplementations. - AbstractShellService(Console) - 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.
- addArguments(Arguments) - Method in class com.aspectran.shell.command.AbstractCommand
- addCommand(Class<? extends Command>) - Method in class com.aspectran.shell.command.ShellCommandRegistry
- addCommand(String...) - Method in class com.aspectran.shell.command.ShellCommandRegistry
- addOption(Option) - Method in class com.aspectran.shell.command.AbstractCommand
- addOption(Option) - Method in class com.aspectran.shell.command.option.OptionGroup
-
Add the specified
Optionto 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.
- addOptionGroup(OptionGroup) - Method in class com.aspectran.shell.command.option.Options
-
Add the specified option group.
- 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
AlreadySelectedExceptionfor the specified option group. - AlreadySelectedException(String) - Constructor for exception com.aspectran.shell.command.option.AlreadySelectedException
-
Construct a new
AlreadySelectedExceptionwith 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.OutputRedirection.Operator
-
Appends command output to the end of a text file.
- appendPrompt(String) - Method in class com.aspectran.shell.console.AbstractConsole
- appendPrompt(String) - Method in interface com.aspectran.shell.console.Console
- appendPrompt(String) - Method in class com.aspectran.shell.console.ConsoleWrapper
- Arguments - Class in com.aspectran.shell.command.option
-
Created: 2019-01-18
- Arguments() - Constructor for class com.aspectran.shell.command.option.Arguments
- AspectCommand - Class in com.aspectran.shell.command.builtins
-
Change the active state of an Aspect or view the list of registered Aspect.
- AspectCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtins.AspectCommand
- AspectranShell - Class in com.aspectran.shell
-
Main entry point for the Aspectran Shell.
- AspectranShell() - Constructor for class com.aspectran.shell.AspectranShell
- attribute(String...) - Method in class com.aspectran.shell.console.AnsiStyleHandler
B
- BOOLEAN - com.aspectran.shell.command.option.OptionValueType
- bootstrap(File, Console) - Static method in class com.aspectran.shell.AspectranShell
- bootstrap(String, File, Console) - Static method in class com.aspectran.shell.AspectranShell
- 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.Builderto create anOptionusing descriptive methods. - builder(String) - Static method in class com.aspectran.shell.command.option.Option
-
Returns a
Option.Builderto create anOptionusing descriptive methods.
C
- character(char) - Method in class com.aspectran.shell.console.AnsiStyleHandler
- ClearCommand - Class in com.aspectran.shell.command.builtins
-
Clear the terminal screen.
- ClearCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtins.ClearCommand
- clearCommandHistory() - Method in interface com.aspectran.shell.console.Console
- clearCommandHistory() - Method in class com.aspectran.shell.console.ConsoleWrapper
- clearCommandHistory() - Method in class com.aspectran.shell.console.DefaultConsole
- clearLine() - Method in interface com.aspectran.shell.console.Console
- clearLine() - Method in class com.aspectran.shell.console.ConsoleWrapper
- clearLine() - Method in class com.aspectran.shell.console.DefaultConsole
- clearPrompt() - Method in class com.aspectran.shell.console.AbstractConsole
- clearPrompt() - Method in interface com.aspectran.shell.console.Console
- clearPrompt() - Method in class com.aspectran.shell.console.ConsoleWrapper
- clearScreen() - Method in interface com.aspectran.shell.console.Console
- clearScreen() - Method in class com.aspectran.shell.console.ConsoleWrapper
- 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.command.OutputRedirection.MultiWriter
- com.aspectran.shell - package com.aspectran.shell
-
Package required to build shell (aka command line) applications.
- 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.builtins - package com.aspectran.shell.command.builtins
-
Built-in commands provided by Aspectran Shell.
- 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 allows the command interpreter 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.
- CommandInterpreter - Interface in com.aspectran.shell.command
-
The Shell Command Interpreter.
- CommandLineParser - Class in com.aspectran.shell.command
-
The Command Line Parser.
- CommandLineParser(String) - Constructor for class com.aspectran.shell.command.CommandLineParser
- CommandReadFailedException - Exception in com.aspectran.shell.console
-
Exception thrown when a command fails to read.
- CommandReadFailedException() - Constructor for exception com.aspectran.shell.console.CommandReadFailedException
-
Simple constructor.
- CommandReadFailedException(String) - Constructor for exception com.aspectran.shell.console.CommandReadFailedException
-
Constructor to create exception with a message.
- CommandReadFailedException(String, Throwable) - Constructor for exception com.aspectran.shell.console.CommandReadFailedException
-
Constructor to create exception to wrap another exception and pass a message.
- CommandReadFailedException(Throwable) - Constructor for exception com.aspectran.shell.console.CommandReadFailedException
-
Constructor to create exception to wrap another exception.
- CommandRegistry - Interface in com.aspectran.shell.command
-
A registry that contains the commands known by a shell.
- COMMENT_DELIMITER - Static variable in interface com.aspectran.shell.console.Console
- COMMENT_PROMPT - Static variable in interface com.aspectran.shell.console.Console
- confirmQuit() - Method in interface com.aspectran.shell.console.Console
- confirmQuit() - Method in class com.aspectran.shell.console.ConsoleWrapper
- 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.ConsoleWrapper
- 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.ConsoleWrapper
- 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.console
-
This exception raised if a console is terminated.
- ConsoleTerminatedException() - Constructor for exception com.aspectran.shell.console.ConsoleTerminatedException
-
Simple constructor.
- ConsoleTerminatedException(String) - Constructor for exception com.aspectran.shell.console.ConsoleTerminatedException
-
Constructor to create exception with a message.
- ConsoleTerminatedException(String, Throwable) - Constructor for exception com.aspectran.shell.console.ConsoleTerminatedException
-
Constructor to create exception to wrap another exception and pass a message.
- ConsoleTerminatedException(Throwable) - Constructor for exception com.aspectran.shell.console.ConsoleTerminatedException
-
Constructor to create exception to wrap another exception.
- ConsoleWrapper - Class in com.aspectran.shell.console
- ConsoleWrapper(Console) - Constructor for class com.aspectran.shell.console.ConsoleWrapper
- create(AspectranConfig, Console) - Static method in class com.aspectran.shell.service.DefaultShellService
-
Returns a new instance of
DefaultShellService. - createPadding(int) - Static method in class com.aspectran.shell.command.option.OptionUtils
-
Return a String of padding of length
len.
D
- 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_MAX_LEFT_WIDTH - Static variable in class com.aspectran.shell.command.option.HelpFormatter
-
Default number of characters per line
- DEFAULT_PROMPT - Static variable in interface com.aspectran.shell.console.Console
- 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.
- DefaultShellService - Class in com.aspectran.shell.service
-
Provides an interactive shell that lets you use or control Aspectran directly from the command line.
- desc(String) - Method in class com.aspectran.shell.command.option.Option.Builder
-
Sets the description for this option.
- destroySessionManager() - Method in class com.aspectran.shell.service.AbstractShellService
- determineOutputWriter(List<OutputRedirection>, Console) - Static method in class com.aspectran.shell.command.OutputRedirection
-
Returns the
Writerinstances for translet output redirection. - DOUBLE - com.aspectran.shell.command.option.OptionValueType
E
- EchoCommand - Class in com.aspectran.shell.command.builtins
-
Displays a message on the screen.
- EchoCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtins.EchoCommand
- equals(Object) - Method in class com.aspectran.shell.command.option.Option
- equals(Object) - Method in class com.aspectran.shell.command.OutputRedirection
- execute(ParsedOptions, Console) - Method in class com.aspectran.shell.command.builtins.AspectCommand
- execute(ParsedOptions, Console) - Method in class com.aspectran.shell.command.builtins.ClearCommand
- execute(ParsedOptions, Console) - Method in class com.aspectran.shell.command.builtins.EchoCommand
- execute(ParsedOptions, Console) - Method in class com.aspectran.shell.command.builtins.HelpCommand
- execute(ParsedOptions, Console) - Method in class com.aspectran.shell.command.builtins.HistoryCommand
- execute(ParsedOptions, Console) - Method in class com.aspectran.shell.command.builtins.JobCommand
- execute(ParsedOptions, Console) - Method in class com.aspectran.shell.command.builtins.PBDecryptCommand
- execute(ParsedOptions, Console) - Method in class com.aspectran.shell.command.builtins.PBEncryptCommand
- execute(ParsedOptions, Console) - Method in class com.aspectran.shell.command.builtins.QuitCommand
- execute(ParsedOptions, Console) - Method in class com.aspectran.shell.command.builtins.RestartCommand
- execute(ParsedOptions, Console) - Method in class com.aspectran.shell.command.builtins.SysInfoCommand
- execute(ParsedOptions, Console) - Method in class com.aspectran.shell.command.builtins.TransletCommand
- execute(ParsedOptions, Console) - Method in class com.aspectran.shell.command.builtins.VerboseCommand
- execute(ParsedOptions, Console) - 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.
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
startPosfor the text intextwith the column widthwidth. - FLOAT - com.aspectran.shell.command.option.OptionValueType
- flush() - Method in class com.aspectran.shell.command.OutputRedirection.MultiWriter
G
- getAllCommands() - Method in interface com.aspectran.shell.command.CommandRegistry
- getAllCommands() - Method in class com.aspectran.shell.command.ShellCommandRegistry
- getAllOptions() - Method in class com.aspectran.shell.command.option.Options
-
Retrieve a read-only list of options in this set.
- 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
- getArgs() - Method in class com.aspectran.shell.command.CommandLineParser
- getArgs() - Method in class com.aspectran.shell.command.option.ParsedOptions
-
Retrieve any left-over non-recognized options and arguments.
- getArgumentsList() - Method in class com.aspectran.shell.command.AbstractCommand
- getArgumentsList() - Method in class com.aspectran.shell.command.builtins.HelpCommand
- getArgumentsList() - Method in interface com.aspectran.shell.command.Command
- getClassType() - Method in enum com.aspectran.shell.command.option.OptionValueType
- getCommand(Class<? extends Command>) - Method in interface com.aspectran.shell.command.CommandRegistry
- getCommand(Class<? extends Command>) - Method in class com.aspectran.shell.command.ShellCommandRegistry
- getCommand(String) - Method in interface com.aspectran.shell.command.CommandRegistry
- getCommand(String) - Method in class com.aspectran.shell.command.ShellCommandRegistry
- getCommandHistory() - Method in interface com.aspectran.shell.console.Console
- getCommandHistory() - Method in class com.aspectran.shell.console.ConsoleWrapper
- getCommandHistory() - Method in class com.aspectran.shell.console.DefaultConsole
- getCommandLine() - Method in class com.aspectran.shell.command.CommandLineParser
- getCommandName() - Method in class com.aspectran.shell.command.CommandLineParser
- getCommandPrompt() - Method in class com.aspectran.shell.console.AbstractConsole
- getCommandPrompt() - Method in interface com.aspectran.shell.console.Console
- getCommandPrompt() - Method in class com.aspectran.shell.console.ConsoleWrapper
- getCommandRegistry() - Method in class com.aspectran.shell.command.AbstractCommand
- getCommandRegistry() - Method in interface com.aspectran.shell.command.CommandInterpreter
- getCommandRegistry() - Method in class com.aspectran.shell.command.ShellCommandInterpreter
- getConsole() - Method in interface com.aspectran.shell.command.CommandInterpreter
- getConsole() - Method in class com.aspectran.shell.command.ShellCommandInterpreter
- getDescPad() - Method in class com.aspectran.shell.command.option.HelpFormatter
- 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.builtins.AspectCommand
- getDescriptor() - Method in class com.aspectran.shell.command.builtins.ClearCommand
- getDescriptor() - Method in class com.aspectran.shell.command.builtins.EchoCommand
- getDescriptor() - Method in class com.aspectran.shell.command.builtins.HelpCommand
- getDescriptor() - Method in class com.aspectran.shell.command.builtins.HistoryCommand
- getDescriptor() - Method in class com.aspectran.shell.command.builtins.JobCommand
- getDescriptor() - Method in class com.aspectran.shell.command.builtins.PBDecryptCommand
- getDescriptor() - Method in class com.aspectran.shell.command.builtins.PBEncryptCommand
- getDescriptor() - Method in class com.aspectran.shell.command.builtins.QuitCommand
- getDescriptor() - Method in class com.aspectran.shell.command.builtins.RestartCommand
- getDescriptor() - Method in class com.aspectran.shell.command.builtins.SysInfoCommand
- getDescriptor() - Method in class com.aspectran.shell.command.builtins.TransletCommand
- getDescriptor() - Method in class com.aspectran.shell.command.builtins.VerboseCommand
- getDescriptor() - Method in interface com.aspectran.shell.command.Command
-
This method returns an instance of Command.Descriptor.
- getEncoding() - Method in class com.aspectran.shell.console.AbstractConsole
- getEncoding() - Method in interface com.aspectran.shell.console.Console
- getEncoding() - Method in class com.aspectran.shell.console.ConsoleWrapper
- getEncoding() - Method in class com.aspectran.shell.console.DefaultConsole
- getFirstArg() - Method in class com.aspectran.shell.command.option.ParsedOptions
- getGreetings() - Method in class com.aspectran.shell.service.AbstractShellService
- getGreetings() - Method in interface com.aspectran.shell.service.ShellService
-
Returns the greeting message.
- getHelpOptions() - Method in class com.aspectran.shell.command.option.Options
-
Returns the Options for use by the HelpFormatter.
- getId() - Method in class com.aspectran.shell.command.option.Option
-
Returns the id of this Option.
- getInterpreter() - Method in class com.aspectran.shell.command.AbstractCommand
- getInterpreter() - Method in interface com.aspectran.shell.command.CommandRegistry
- getInterpreter() - Method in class com.aspectran.shell.command.ShellCommandRegistry
- getInterpreter() - Method in class com.aspectran.shell.console.AbstractConsole
- getInterpreter() - Method in interface com.aspectran.shell.console.Console
- getInterpreter() - Method in class com.aspectran.shell.console.ConsoleWrapper
- getKey() - Method in class com.aspectran.shell.command.option.Option
-
Returns the 'unique' Option identifier.
- getLeftPad() - Method in class com.aspectran.shell.command.option.HelpFormatter
- getLineParser() - Method in class com.aspectran.shell.command.AbstractCommandLine
-
Returns the command line parser.
- getLongName() - Method in class com.aspectran.shell.command.option.Option
-
Retrieve the long name of this Option.
- 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.
- getMaxLeftWidth() - Method in class com.aspectran.shell.command.option.HelpFormatter
- 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.
- getName() - Method in class com.aspectran.shell.command.option.Option
-
Retrieve the name of this Option.
- 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.
- getNumberOfValues() - Method in class com.aspectran.shell.command.option.Option
-
Returns the number of argument values this Option can take.
- getOperand() - Method in class com.aspectran.shell.command.OutputRedirection
- getOperator() - Method in class com.aspectran.shell.command.OutputRedirection
- 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.MissingOptionValueException
-
Return the option requiring a value 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
Optionmatching 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
optbelongs to. - getOptions() - Method in class com.aspectran.shell.command.AbstractCommand
- getOptions() - Method in interface com.aspectran.shell.command.Command
- getOptions() - Method in class com.aspectran.shell.command.option.OptionGroup
- getOptions() - Method in class com.aspectran.shell.command.option.ParsedOptions
-
Returns an array of the processed
Options. - getOutput() - Method in interface com.aspectran.shell.console.Console
- getOutput() - Method in class com.aspectran.shell.console.ConsoleWrapper
- getOutput() - Method in class com.aspectran.shell.console.DefaultConsole
- getParameterMap() - Method in class com.aspectran.shell.command.AbstractCommandLine
-
Returns the parameters to pass to the execution target extracted from the command line.
- getPrompt() - Method in class com.aspectran.shell.console.AbstractConsole
- 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
-
Returns a list of the output redirection extracted from the command line.
- getRequestMethod() - Method in class com.aspectran.shell.command.TransletCommandLine
-
Returns the request method of the target translet extracted from the command line.
- getRequestName() - Method in class com.aspectran.shell.command.AbstractCommandLine
-
Returns the name of the request extracted from the command line.
- 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 interface com.aspectran.shell.command.CommandInterpreter
- getService() - Method in class com.aspectran.shell.command.ShellCommandInterpreter
- getStyles() - Method in interface com.aspectran.shell.console.Console
- getStyles() - Method in class com.aspectran.shell.console.ConsoleWrapper
- getStyles() - Method in class com.aspectran.shell.console.DefaultConsole
- getSyntaxPrefix() - Method in class com.aspectran.shell.command.option.HelpFormatter
- getTitle() - Method in class com.aspectran.shell.command.option.Arguments
- getTitle() - Method in class com.aspectran.shell.command.option.Options
- getTypedValue(char) - Method in class com.aspectran.shell.command.option.ParsedOptions
-
Return a version of this
Optionconverted to a particular type. - getTypedValue(Option) - Method in class com.aspectran.shell.command.option.ParsedOptions
-
Return a version of this
Optionconverted to a particular type. - getTypedValue(String) - Method in class com.aspectran.shell.command.option.ParsedOptions
-
Return a version of this
Optionconverted to a particular type. - 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
nullif 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
nullif 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
defaultValueif 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.
- getValueName() - Method in class com.aspectran.shell.command.option.Option
-
Gets the display name for the argument value.
- 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.
- 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
- getWorkingDir() - Method in class com.aspectran.shell.console.AbstractConsole
- getWorkingDir() - Method in interface com.aspectran.shell.console.Console
- getWorkingDir() - Method in class com.aspectran.shell.console.ConsoleWrapper
- getWriter() - Method in interface com.aspectran.shell.console.Console
- getWriter() - Method in class com.aspectran.shell.console.ConsoleWrapper
- getWriter() - Method in class com.aspectran.shell.console.DefaultConsole
H
- handle(CharSequence) - Method in class com.aspectran.shell.console.AnsiStyleHandler
- hasArgs() - Method in class com.aspectran.shell.command.CommandLineParser
- 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.option.Option
- hashCode() - Method in class com.aspectran.shell.command.OutputRedirection
- hasLongName() - 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
- 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
- hasOption(String) - Method in class com.aspectran.shell.command.option.ParsedOptions
-
Query to see if an option has been set.
- hasOptionalValue() - 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.
- hasShortOption(String) - Method in class com.aspectran.shell.command.option.Options
- hasValue() - Method in class com.aspectran.shell.command.option.Option.Builder
-
Indicates that the Option will require an argument.
- hasValue() - Method in class com.aspectran.shell.command.option.Option
-
Query to see if this Option requires an argument.
- hasValue(boolean) - Method in class com.aspectran.shell.command.option.Option.Builder
-
Indicates if the Option has an argument value or not.
- hasValueName() - Method in class com.aspectran.shell.command.option.Option
-
Returns whether the display name for the argument value has been set.
- hasValues() - Method in class com.aspectran.shell.command.option.Option.Builder
-
Indicates that the Option can have unlimited argument values.
- hasValues() - Method in class com.aspectran.shell.command.option.Option
-
Query to see if this Option can take many values.
- HelpCommand - Class in com.aspectran.shell.command.builtins
-
Display information about builtin commands.
- HelpCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtins.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.
- HistoryCommand - Class in com.aspectran.shell.command.builtins
-
A command that display or delete all previously run commands.
- HistoryCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtins.HistoryCommand
I
- init(String, File) - Method in class com.aspectran.shell.command.ShellCommandInterpreter
- initSessionManager() - Method in class com.aspectran.shell.service.AbstractShellService
- INT - com.aspectran.shell.command.option.OptionValueType
- isBusy() - Method in interface com.aspectran.shell.console.Console
- isBusy() - Method in class com.aspectran.shell.console.ConsoleWrapper
- isBusy() - Method in class com.aspectran.shell.console.DefaultConsole
- isBusy() - Method in class com.aspectran.shell.service.AbstractShellService
- isEmpty() - Method in class com.aspectran.shell.command.option.Options
-
Returns
trueif 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
-
Returns whether or not the translet can be exposed to the shell service.
- isRequired() - Method in class com.aspectran.shell.command.option.Arguments
- 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.
- isServiceAvailable() - Method in class com.aspectran.shell.command.AbstractCommand
- isSkipParsingAtNonOption() - Method in class com.aspectran.shell.command.option.Options
- 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.
- isWithEqualSign() - Method in class com.aspectran.shell.command.option.Option
- iterator() - Method in class com.aspectran.shell.command.option.ParsedOptions
-
Returns an iterator over the Option members of ParsedOptions.
J
- JobCommand - Class in com.aspectran.shell.command.builtins
- JobCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtins.JobCommand
L
- LONG - com.aspectran.shell.command.option.OptionValueType
- LONG_OPTION_PREFIX - Static variable in class com.aspectran.shell.command.option.HelpFormatter
-
Default prefix for long Option
- longName(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
- MASK_CHAR - Static variable in interface com.aspectran.shell.console.Console
- 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
MissingSelectedExceptionwith the specified detail message. - MissingOptionException(List<?>) - Constructor for exception com.aspectran.shell.command.option.MissingOptionException
-
Constructs a new
MissingSelectedExceptionwith the specified list of missing options. - MissingOptionValueException - Exception in com.aspectran.shell.command.option
-
Thrown when an option requiring a value is not provided with a value.
- MissingOptionValueException(Option) - Constructor for exception com.aspectran.shell.command.option.MissingOptionValueException
-
Construct a new
MissingOptionValueExceptionwith the specified detail message. - MissingOptionValueException(String) - Constructor for exception com.aspectran.shell.command.option.MissingOptionValueException
-
Construct a new
MissingOptionValueExceptionwith the specified detail message. - MULTILINE_DELIMITER - Static variable in interface com.aspectran.shell.console.Console
- MULTILINE_PROMPT - Static variable in interface com.aspectran.shell.console.Console
- MultiWriter(Writer[]) - Constructor for class com.aspectran.shell.command.OutputRedirection.MultiWriter
N
- newSessionAdapter() - Method in class com.aspectran.shell.service.AbstractShellService
- newSessionAdapter() - Method in interface com.aspectran.shell.service.ShellService
-
Create and return a new session adapter from the shell service.
- numberOfValues(int) - Method in class com.aspectran.shell.command.option.Option.Builder
-
Sets the number of argument values the Option can take.
O
- 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_PREFIX - Static variable in class com.aspectran.shell.command.option.HelpFormatter
-
Default prefix for shortOpts
- Option.Builder - Class in com.aspectran.shell.command.option
-
A nested builder class to create
Optioninstances using descriptive methods. - optionalValue() - Method in class com.aspectran.shell.command.option.Option.Builder
-
Sets whether the Option can have an optional argument value.
- 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
OptionParserinterface can parse a String array according to theOptionsspecified and return aParsedOptions. - 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
OptionParseExceptionwith the specified detail message. - Options - Class in com.aspectran.shell.command.option
-
Main entry-point into the library.
- Options() - Constructor for class com.aspectran.shell.command.option.Options
- Options(boolean) - 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.
- OutputRedirection - Class in com.aspectran.shell.command
-
Created: 2017.
- OutputRedirection(OutputRedirection.Operator) - Constructor for class com.aspectran.shell.command.OutputRedirection
- OutputRedirection.MultiWriter - Class in com.aspectran.shell.command
-
The writer that handles multiple writers.
- OutputRedirection.Operator - Enum in com.aspectran.shell.command
-
Output redirection operators.
- OVERWRITE_OUT - com.aspectran.shell.command.OutputRedirection.Operator
-
Writes the command output to a text file.
P
- parse() - Method in class com.aspectran.shell.command.AbstractCommandLine
- parse() - Method in class com.aspectran.shell.command.TransletCommandLine
- 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.
- ParsedOptions - Class in com.aspectran.shell.command.option
-
Represents list of arguments parsed against a
Optionsdescriptor. - ParsedOptions() - Constructor for class com.aspectran.shell.command.option.ParsedOptions
- parseOptions(Options) - Method in class com.aspectran.shell.command.CommandLineParser
- parseRequest() - Method in class com.aspectran.shell.activity.ShellActivity
- PBDecryptCommand - Class in com.aspectran.shell.command.builtins
-
Decrypts the input string using the encryption password.
- PBDecryptCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtins.PBDecryptCommand
- PBEncryptCommand - Class in com.aspectran.shell.command.builtins
-
Encrypts the input string using the encryption password.
- PBEncryptCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtins.PBEncryptCommand
- perform() - Method in class com.aspectran.shell.command.ShellCommandInterpreter
- printArguments(List<Arguments>, int) - Method in class com.aspectran.shell.command.option.HelpFormatter
- printGreetings() - Method in class com.aspectran.shell.service.AbstractShellService
- printGreetings() - Method in interface com.aspectran.shell.service.ShellService
-
Prints greeting message.
- printHelp() - Method in class com.aspectran.shell.service.AbstractShellService
- printHelp() - Method in interface com.aspectran.shell.service.ShellService
-
Prints help information.
- printHelp(Command) - Method in class com.aspectran.shell.command.option.HelpFormatter
-
Print the help with the given Command object.
- printHelp(Console) - Method in class com.aspectran.shell.command.AbstractCommand
- printHelp(Console) - Method in interface com.aspectran.shell.command.Command
-
Prints the usage statement for the specified command.
- printOptions(Options) - 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.
- printQuickHelp(Console) - Method in class com.aspectran.shell.command.AbstractCommand
- printQuickHelp(Console) - Method in interface com.aspectran.shell.command.Command
- printUsage(Command) - Method in class com.aspectran.shell.command.option.HelpFormatter
-
Prints the usage statement for the specified command.
- printUsage(String) - Method in class com.aspectran.shell.command.option.HelpFormatter
-
Print the help for
optionswith the specified command line syntax. - printWrapped(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.builtins
-
Releases all resources and exits this application.
- QuitCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtins.QuitCommand
R
- readCommandLine() - Method in interface com.aspectran.shell.console.Console
- readCommandLine() - Method in class com.aspectran.shell.console.ConsoleWrapper
- 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.ConsoleWrapper
- 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.ConsoleWrapper
- 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.ConsoleWrapper
- readLine(String) - Method in class com.aspectran.shell.console.DefaultConsole
- readLine(String, String) - Method in interface com.aspectran.shell.console.Console
- readLine(String, String) - Method in class com.aspectran.shell.console.ConsoleWrapper
- readLine(String, String) - Method in class com.aspectran.shell.console.DefaultConsole
- readMultiCommandLine(String) - Method in class com.aspectran.shell.console.AbstractConsole
- readMultiLine(String) - Method in class com.aspectran.shell.console.AbstractConsole
- readPassword() - Method in interface com.aspectran.shell.console.Console
- readPassword() - Method in class com.aspectran.shell.console.ConsoleWrapper
- 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.ConsoleWrapper
- readPassword(String) - Method in class com.aspectran.shell.console.DefaultConsole
- readPassword(String, String) - Method in interface com.aspectran.shell.console.Console
- readPassword(String, String) - Method in class com.aspectran.shell.console.ConsoleWrapper
- readPassword(String, String) - Method in class com.aspectran.shell.console.DefaultConsole
- readRawCommandLine(String) - Method in class com.aspectran.shell.console.AbstractConsole
- readRawCommandLine(String) - Method in class com.aspectran.shell.console.DefaultConsole
- readRawLine(String) - Method in class com.aspectran.shell.console.AbstractConsole
- readRawLine(String) - Method in class com.aspectran.shell.console.DefaultConsole
- redrawLine() - Method in interface com.aspectran.shell.console.Console
- redrawLine() - Method in class com.aspectran.shell.console.ConsoleWrapper
- redrawLine() - Method in class com.aspectran.shell.console.DefaultConsole
- release() - Method in class com.aspectran.shell.activity.ShellActivity
- release() - Method in class com.aspectran.shell.command.ShellCommandInterpreter
- renderWrappedText(StringBuilder, int, int, String) - Static 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
OptionValueTypewith a value represented by the specifiedString. - restart(String) - Method in class com.aspectran.shell.service.AbstractShellService
- RestartCommand - Class in com.aspectran.shell.command.builtins
-
Restarts the Aspectran Shell.
- RestartCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtins.RestartCommand
- rtrim(String) - Static method in class com.aspectran.shell.command.option.OptionUtils
-
Remove the trailing whitespace from the specified String.
S
- serialize(Collection<OutputRedirection>) - Static method in class com.aspectran.shell.command.OutputRedirection
- setArgName(String) - Method in class com.aspectran.shell.command.option.HelpFormatter
- setCommandHistoryFile(String) - Method in interface com.aspectran.shell.console.Console
- setCommandHistoryFile(String) - Method in class com.aspectran.shell.console.ConsoleWrapper
- setCommandHistoryFile(String) - Method in class com.aspectran.shell.console.DefaultConsole
- setCommandName(String) - Method in class com.aspectran.shell.command.CommandLineParser
- setCommandPrompt(String) - Method in class com.aspectran.shell.console.AbstractConsole
- setCommandPrompt(String) - Method in interface com.aspectran.shell.console.Console
- setCommandPrompt(String) - Method in class com.aspectran.shell.console.ConsoleWrapper
- setDescPad(int) - Method in class com.aspectran.shell.command.option.HelpFormatter
- 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
-
Specifies the greeting message.
- setInterpreter(CommandInterpreter) - Method in class com.aspectran.shell.console.AbstractConsole
- setInterpreter(CommandInterpreter) - Method in interface com.aspectran.shell.console.Console
- setInterpreter(CommandInterpreter) - Method in class com.aspectran.shell.console.ConsoleWrapper
- setLeftPad(int) - Method in class com.aspectran.shell.command.option.HelpFormatter
- setLongName(String) - Method in class com.aspectran.shell.command.option.Option
-
Sets the long name of this Option.
- setMaxLeftWidth(int) - Method in class com.aspectran.shell.command.option.HelpFormatter
- setNumberOfValues(int) - Method in class com.aspectran.shell.command.option.Option
-
Sets the number of argument values this Option can take.
- setOperand(String) - Method in class com.aspectran.shell.command.OutputRedirection
- setOptionalValue(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.
- setOutputWriter(Writer) - Method in class com.aspectran.shell.activity.ShellActivity
- setParameterMap(ParameterMap) - Method in class com.aspectran.shell.activity.ShellActivity
- setProcedural(boolean) - Method in class com.aspectran.shell.activity.ShellActivity
- setRequired(boolean) - Method in class com.aspectran.shell.command.option.Arguments
- 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. - setSkipParsingAtNonOption(boolean) - Method in class com.aspectran.shell.command.option.Options
- setStyle(String...) - Method in interface com.aspectran.shell.console.Console
- setStyle(String...) - Method in class com.aspectran.shell.console.ConsoleWrapper
- setStyle(String...) - Method in class com.aspectran.shell.console.DefaultConsole
- setSyntaxPrefix(String) - Method in class com.aspectran.shell.command.option.HelpFormatter
- setTitle(String) - Method in class com.aspectran.shell.command.option.Arguments
- setTitle(String) - Method in class com.aspectran.shell.command.option.Options
- setValueName(String) - Method in class com.aspectran.shell.command.option.Option
-
Sets the display name for the argument value.
- 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
- setWithEqualSign(boolean) - Method in class com.aspectran.shell.command.option.Option
- setWorkingDir(File) - Method in class com.aspectran.shell.console.AbstractConsole
- setWorkingDir(File) - Method in interface com.aspectran.shell.console.Console
- setWorkingDir(File) - Method in class com.aspectran.shell.console.ConsoleWrapper
- setWriter(PrintWriter) - Method in class com.aspectran.shell.console.ConsoleWrapper
- ShellActivity - Class in com.aspectran.shell.activity
-
An activity that processes a shell command.
- ShellActivity(ShellService, Console) - Constructor for class com.aspectran.shell.activity.ShellActivity
-
Instantiates a new ShellActivity.
- ShellCommandInterpreter - Class in com.aspectran.shell.command
-
The Shell Command Interpreter.
- ShellCommandInterpreter(Console) - Constructor for class com.aspectran.shell.command.ShellCommandInterpreter
- ShellCommandRegistry - Class in com.aspectran.shell.command
-
A registry that contains the commands known by a shell.
- ShellCommandRegistry(CommandInterpreter) - Constructor for class com.aspectran.shell.command.ShellCommandRegistry
- ShellRequestAdapter - Class in com.aspectran.shell.adapter
-
Adapt Shell Request to Core
RequestAdapter. - ShellRequestAdapter(MethodType) - Constructor for class com.aspectran.shell.adapter.ShellRequestAdapter
-
Instantiates a new ShellRequestAdapter.
- ShellResponseAdapter - Class in com.aspectran.shell.adapter
-
Adapt Shell Response to Core
ResponseAdapter. - 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
-
Adapt
SessionAgentto CoreSessionAdapter. - ShellSessionAdapter(SessionAgent) - Constructor for class com.aspectran.shell.adapter.ShellSessionAdapter
-
Instantiates a new ShellSessionAdapter.
- shift() - Method in class com.aspectran.shell.command.CommandLineParser
- skipParsingAtNonOption() - Method in class com.aspectran.shell.command.AbstractCommand
- STRING - com.aspectran.shell.command.option.OptionValueType
- styleOff() - Method in interface com.aspectran.shell.console.Console
- styleOff() - Method in class com.aspectran.shell.console.ConsoleWrapper
- styleOff() - Method in class com.aspectran.shell.console.DefaultConsole
- SysInfoCommand - Class in com.aspectran.shell.command.builtins
-
Displays current JVM runtime information.
- SysInfoCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtins.SysInfoCommand
T
- 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
- toString() - Method in enum com.aspectran.shell.command.OutputRedirection.Operator
- toString() - Method in class com.aspectran.shell.command.OutputRedirection
- touchArguments() - Method in class com.aspectran.shell.command.AbstractCommand
- translate(TransletCommandLine, Console) - Method in class com.aspectran.shell.service.DefaultShellService
- translate(TransletCommandLine, Console) - Method in interface com.aspectran.shell.service.ShellService
-
Executes translet.
- TransletCommand - Class in com.aspectran.shell.command.builtins
- TransletCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtins.TransletCommand
- TransletCommandLine - Class in com.aspectran.shell.command
-
Parses the command line entered to execute the translet.
- TransletCommandLine(CommandLineParser) - Constructor for class com.aspectran.shell.command.TransletCommandLine
U
- 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
UnrecognizedArgumentExceptionwith the specified detail message. - UnrecognizedOptionException(String, String) - Constructor for exception com.aspectran.shell.command.option.UnrecognizedOptionException
-
Construct a new
UnrecognizedArgumentExceptionwith the specified option and detail message.
V
- valueName(String) - Method in class com.aspectran.shell.command.option.Option.Builder
-
Sets the display name for the argument value.
- valueOf(String) - Static method in enum com.aspectran.shell.command.option.OptionValueType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.aspectran.shell.command.OutputRedirection.Operator
-
Returns the enum constant of this type with the specified name.
- 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.
- values() - Static method in enum com.aspectran.shell.command.OutputRedirection.Operator
-
Returns an array containing the constants of this enum type, in the order they are declared.
- 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.builtins
-
Turns on or off the mode that displays a description of the translet before it is executed.
- VerboseCommand(CommandRegistry) - Constructor for class com.aspectran.shell.command.builtins.VerboseCommand
W
- withEqualSign() - Method in class com.aspectran.shell.command.option.Option.Builder
-
The Option will use '=' as a means to separate argument value.
- withEqualSign() - Method in class com.aspectran.shell.command.option.Option
- write(char[], int, int) - Method in class com.aspectran.shell.command.OutputRedirection.MultiWriter
- write(String) - Method in interface com.aspectran.shell.console.Console
- write(String) - Method in class com.aspectran.shell.console.ConsoleWrapper
- 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.ConsoleWrapper
- write(String, Object...) - Method in class com.aspectran.shell.console.DefaultConsole
- writeError(String) - Method in interface com.aspectran.shell.console.Console
- writeError(String) - Method in class com.aspectran.shell.console.ConsoleWrapper
- writeError(String) - Method in class com.aspectran.shell.console.DefaultConsole
- writeError(String, Object...) - Method in interface com.aspectran.shell.console.Console
- writeError(String, Object...) - Method in class com.aspectran.shell.console.ConsoleWrapper
- writeError(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.ConsoleWrapper
- 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.ConsoleWrapper
- 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.ConsoleWrapper
- writeLine(String, Object...) - Method in class com.aspectran.shell.console.DefaultConsole
All Classes All Packages