A C D E F G H I J K L M N O P R S T

A

add(Integer...) - Method in class org.lsst.ccs.shell.example.Example

add(int, int) - Method in class org.lsst.ccs.shell.example.HelloWorld

addAuxHandler(Object, String) - Method in class org.lsst.ccs.shell.Shell

This method is very similar to addMainHandler, except ShellFactory will pass all handlers registered with this method to all this shell's subshells.

addCompleter(Completer) - Method in class org.lsst.ccs.shell.ConsoleIO

addCompleter(Completer) - Method in class org.lsst.ccs.shell.Shell

addConverter(InputConverter) - Method in class org.lsst.ccs.shell.InputConversionEngine

addConverter(OutputConverter) - Method in class org.lsst.ccs.shell.OutputConversionEngine

addDeclaredConverters(Object) - Method in class org.lsst.ccs.shell.InputConversionEngine

addDeclaredConverters(Object) - Method in class org.lsst.ccs.shell.OutputConversionEngine

addMainHandler(Object, String) - Method in class org.lsst.ccs.shell.Shell

Method for registering command hanlers (or providers?) You call it, and from then the Shell has all commands declare in the handler object.

addMethod(Method, Object, String) - Method in class org.lsst.ccs.shell.CommandTable

addShellCommand(ShellCommand) - Method in class org.lsst.ccs.shell.CommandTable

ArrayHashMultiMap<K,V> - Class in org.lsst.ccs.shell.util

ArrayHashMultiMap() - Constructor for class org.lsst.ccs.shell.util.ArrayHashMultiMap

ArrayHashMultiMap(MultiMap<K, V>) - Constructor for class org.lsst.ccs.shell.util.ArrayHashMultiMap

C

canBeDenotedBy(String) - Method in class org.lsst.ccs.shell.ShellCommand

CLI_INPUT_CONVERTERS - Static variable in class org.lsst.ccs.shell.example.Example

CLI_OUTPUT_CONVERTERS - Static variable in class org.lsst.ccs.shell.example.Example

cliEnterLoop() - Method in class org.lsst.ccs.shell.ConsoleIO

cliEnterLoop() - Method in interface org.lsst.ccs.shell.ShellManageable

This method is called when it is about to enter the command loop.

CLIException - Exception in org.lsst.ccs.shell

Root exception for Cliche.

CLIException() - Constructor for exception org.lsst.ccs.shell.CLIException

CLIException(String) - Constructor for exception org.lsst.ccs.shell.CLIException

CLIException(Throwable) - Constructor for exception org.lsst.ccs.shell.CLIException

CLIException(String, Throwable) - Constructor for exception org.lsst.ccs.shell.CLIException

cliLeaveLoop() - Method in class org.lsst.ccs.shell.ConsoleIO

cliLeaveLoop() - Method in interface org.lsst.ccs.shell.ShellManageable

This method is called when Shell is leaving the command loop.

cliSetShell(Shell) - Method in class org.lsst.ccs.shell.example.Example

cliSetShell(Shell) - Method in class org.lsst.ccs.shell.HelpCommandHandler

cliSetShell(Shell) - Method in interface org.lsst.ccs.shell.ShellDependent

This method informs the object about the Shell operating it.

Command - Annotation Type in org.lsst.ccs.shell

Annotation for commands.

commandLoop() - Method in class org.lsst.ccs.shell.Shell

Runs the command session.

commandName - Variable in class org.lsst.ccs.shell.CommandNamer.NamingInfo

CommandNamer - Interface in org.lsst.ccs.shell

This interface is a Strategy for auto-naming commands with no name specified based on command's method.

CommandNamer.NamingInfo - Class in org.lsst.ccs.shell

Return value grouping structure for nameCommand().

CommandNamer.NamingInfo(String, String[]) - Constructor for class org.lsst.ccs.shell.CommandNamer.NamingInfo

commandsByName(String) - Method in class org.lsst.ccs.shell.CommandTable

CommandTable - Class in org.lsst.ccs.shell

Command table is responsible for managing a lot of ShellCommands and is like a dictionary, because its main function is to return a command by name.

CommandTable(CommandNamer) - Constructor for class org.lsst.ccs.shell.CommandTable

ConsoleIO - Class in org.lsst.ccs.shell

Console IO subsystem.

ConsoleIO() - Constructor for class org.lsst.ccs.shell.ConsoleIO

convertInput(String, Class) - Method in class org.lsst.ccs.shell.InputConversionEngine

convertInput(String, Class) - Method in interface org.lsst.ccs.shell.InputConverter

String-to-someClass conversion method May throw any exception if string is considered invalid for given class; must do nothing but return null if doesn't recognize the toClass.

convertOutput(Object) - Method in class org.lsst.ccs.shell.OutputConversionEngine

convertOutput(Object) - Method in interface org.lsst.ccs.shell.OutputConverter

Object-to--user-friendly-object (usually string) conversion method.

convertToParameters(List<Token>, Class[], boolean) - Method in class org.lsst.ccs.shell.InputConversionEngine

createAmbiguousCommandExc(String, int) - Static method in exception org.lsst.ccs.shell.CLIException

createCommandNotFound(String) - Static method in exception org.lsst.ccs.shell.CLIException

createCommandNotFoundForArgNum(String, int) - Static method in exception org.lsst.ccs.shell.CLIException

createConsoleShell(String, String, Object...) - Static method in class org.lsst.ccs.shell.ShellFactory

One of facade methods for operating the Shell.

createConsoleShell(String, String, Object, MultiMap<String, Object>) - Static method in class org.lsst.ccs.shell.ShellFactory

Facade method for operating the Shell allowing specification of auxiliary handlers (i.e.

createConsoleShell(String, String, Object) - Static method in class org.lsst.ccs.shell.ShellFactory

Facade method for operating the Shell.

createSubshell(String, Shell, String, Object, MultiMap<String, Object>) - Static method in class org.lsst.ccs.shell.ShellFactory

Facade method facilitating the creation of subshell.

createSubshell(String, Shell, String, Object) - Static method in class org.lsst.ccs.shell.ShellFactory

Facade method facilitating the creation of subshell.

createWithAddedAuxHandlers(MultiMap<String, Object>) - Method in class org.lsst.ccs.shell.Shell.Settings

D

DashJoinedNamer - Class in org.lsst.ccs.shell

Default "dash-joined" implementation of the CommandNamer.

DashJoinedNamer(boolean) - Constructor for class org.lsst.ccs.shell.DashJoinedNamer

disableFileHistory() - Method in class org.lsst.ccs.shell.ConsoleIO

disableLogging() - Method in class org.lsst.ccs.shell.ConsoleIO

E

echo(String) - Method in class org.lsst.ccs.shell.example.HelloWorld

EmptyMultiMap<K,V> - Class in org.lsst.ccs.shell.util

EmptyMultiMap() - Constructor for class org.lsst.ccs.shell.util.EmptyMultiMap

enableFileHistory(String) - Method in class org.lsst.ccs.shell.ConsoleIO

enableLogging(String) - Method in class org.lsst.ccs.shell.ConsoleIO

equals(Object) - Method in class org.lsst.ccs.shell.CommandNamer.NamingInfo

equals(Object) - Method in class org.lsst.ccs.shell.Token

escapeString(String) - Static method in class org.lsst.ccs.shell.Token

Escape given string so that tokenize(escapeString(str)).get(0).getString === str.

Example - Class in org.lsst.ccs.shell.example

'more advanced' example.

Example() - Constructor for class org.lsst.ccs.shell.example.Example

F

fixCase(String) - Static method in class org.lsst.ccs.shell.util.Strings

Fixes case of a word: Str -> str, but URL -> URL.

G

generateHTMLHelp(String, boolean) - Method in class org.lsst.ccs.shell.HelpCommandHandler

get(K) - Method in class org.lsst.ccs.shell.util.ArrayHashMultiMap

get(K) - Method in class org.lsst.ccs.shell.util.EmptyMultiMap

get(K) - Method in interface org.lsst.ccs.shell.util.MultiMap

getAbbreviation() - Method in class org.lsst.ccs.shell.ShellCommand

getAppName() - Method in class org.lsst.ccs.shell.Shell

getArity() - Method in class org.lsst.ccs.shell.ShellCommand

getCommandTable() - Method in class org.lsst.ccs.shell.CommandTable

getCommandTable() - Method in class org.lsst.ccs.shell.Shell

getDescription() - Method in class org.lsst.ccs.shell.ShellCommand

getDescription() - Method in class org.lsst.ccs.shell.ShellCommandParamSpec

getHeader() - Method in class org.lsst.ccs.shell.ShellCommand

getIndex() - Method in class org.lsst.ccs.shell.Token

getInputConverter() - Method in class org.lsst.ccs.shell.Shell

Call this method to get InputConversionEngine used by the Shell.

getLastException() - Method in class org.lsst.ccs.shell.Shell

Returns last thrown exception

getName() - Method in class org.lsst.ccs.shell.ShellCommand

getName() - Method in class org.lsst.ccs.shell.ShellCommandParamSpec

getNamer() - Method in class org.lsst.ccs.shell.CommandTable

getOutputConverter() - Method in class org.lsst.ccs.shell.Shell

Call this method to get OutputConversionEngine used by the Shell.

getParameterTypes() - Method in class org.lsst.ccs.shell.ShellCommand

getParamSpecs() - Method in class org.lsst.ccs.shell.ShellCommand

getPath() - Method in class org.lsst.ccs.shell.Shell

getPosition() - Method in class org.lsst.ccs.shell.ShellCommandParamSpec

getPrefix() - Method in class org.lsst.ccs.shell.ShellCommand

getSettings() - Method in class org.lsst.ccs.shell.Shell

getString() - Method in class org.lsst.ccs.shell.Token

getToken() - Method in exception org.lsst.ccs.shell.TokenException

getValueClass() - Method in class org.lsst.ccs.shell.ShellCommandParamSpec

H

hashCode() - Method in class org.lsst.ccs.shell.CommandNamer.NamingInfo

hashCode() - Method in class org.lsst.ccs.shell.Token

Hello() - Method in class org.lsst.ccs.shell.example.Example

HelloWorld - Class in org.lsst.ccs.shell.example

'Hello World!' example.

HelloWorld() - Constructor for class org.lsst.ccs.shell.example.HelloWorld

help() - Method in class org.lsst.ccs.shell.HelpCommandHandler

help(String) - Method in class org.lsst.ccs.shell.HelpCommandHandler

HelpCommandHandler - Class in org.lsst.ccs.shell

Help command handler (usually prefixed by '?').

HelpCommandHandler() - Constructor for class org.lsst.ccs.shell.HelpCommandHandler

history() - Method in class org.lsst.ccs.shell.ConsoleIO

I

Input - Interface in org.lsst.ccs.shell

Input provider for Shell.

InputConversionEngine - Class in org.lsst.ccs.shell

This thing is responsible for converting strings to objects.

InputConversionEngine() - Constructor for class org.lsst.ccs.shell.InputConversionEngine

InputConverter - Interface in org.lsst.ccs.shell

This interface is used by the Shell to support new argument types.

invoke(Object[]) - Method in class org.lsst.ccs.shell.LocalShellCommand

invoke(Object[]) - Method in class org.lsst.ccs.shell.ShellCommand

isVarArgs() - Method in class org.lsst.ccs.shell.ShellCommand

J

joinStrings(List<String>, boolean, char) - Static method in class org.lsst.ccs.shell.util.Strings

Generic string joining function.

K

keySet() - Method in class org.lsst.ccs.shell.util.ArrayHashMultiMap

keySet() - Method in class org.lsst.ccs.shell.util.EmptyMultiMap

keySet() - Method in interface org.lsst.ccs.shell.util.MultiMap

L

list() - Method in class org.lsst.ccs.shell.HelpCommandHandler

list(String) - Method in class org.lsst.ccs.shell.HelpCommandHandler

listAll() - Method in class org.lsst.ccs.shell.HelpCommandHandler

LocalShellCommand - Class in org.lsst.ccs.shell

Command table entry

LocalShellCommand(Object, Method, String, String) - Constructor for class org.lsst.ccs.shell.LocalShellCommand

lookupCommand(String, List<Token>) - Method in class org.lsst.ccs.shell.CommandTable

M

main(String[]) - Static method in class org.lsst.ccs.shell.example.Example

main(String[]) - Static method in class org.lsst.ccs.shell.example.HelloWorld

MultiMap<K,V> - Interface in org.lsst.ccs.shell.util

This is an extension to Java Collections framework.

N

nameCommand(Method) - Method in interface org.lsst.ccs.shell.CommandNamer

Generate command name and suggested abbreviation variants.

nameCommand(Method) - Method in class org.lsst.ccs.shell.DashJoinedNamer

O

org.lsst.ccs.shell - package org.lsst.ccs.shell

org.lsst.ccs.shell.example - package org.lsst.ccs.shell.example

org.lsst.ccs.shell.util - package org.lsst.ccs.shell.util

output(Object, OutputConversionEngine) - Method in class org.lsst.ccs.shell.ConsoleIO

Output - Interface in org.lsst.ccs.shell

Output for Shell to direct its output to.

output(Object, OutputConversionEngine) - Method in interface org.lsst.ccs.shell.Output

OutputConversionEngine - Class in org.lsst.ccs.shell

Output conversion engine is responsible for converting objects after they are returned by command but before they are sent to the Output.

OutputConversionEngine() - Constructor for class org.lsst.ccs.shell.OutputConversionEngine

OutputConverter - Interface in org.lsst.ccs.shell

This interface is used by the Shell to support new return types.

outputException(String, TokenException) - Method in class org.lsst.ccs.shell.ConsoleIO

outputException(Throwable) - Method in class org.lsst.ccs.shell.ConsoleIO

outputException(String, TokenException) - Method in interface org.lsst.ccs.shell.Output

outputException(Throwable) - Method in interface org.lsst.ccs.shell.Output

outputHeader(String) - Method in class org.lsst.ccs.shell.ConsoleIO

outputHeader(String) - Method in interface org.lsst.ccs.shell.Output

P

Param - Annotation Type in org.lsst.ccs.shell

Annotation for parameters of Command-marked methods.

possibleAbbreviations - Variable in class org.lsst.ccs.shell.CommandNamer.NamingInfo

processLine(String) - Method in class org.lsst.ccs.shell.Shell

You can operate Shell linewise, without entering the command loop.

PROJECT_HOMEPAGE_URL - Static variable in class org.lsst.ccs.shell.Shell

put(K, V) - Method in class org.lsst.ccs.shell.util.ArrayHashMultiMap

put(K, V) - Method in class org.lsst.ccs.shell.util.EmptyMultiMap

put(K, V) - Method in interface org.lsst.ccs.shell.util.MultiMap

putAll(MultiMap<K, V>) - Method in class org.lsst.ccs.shell.util.ArrayHashMultiMap

putAll(MultiMap<K, V>) - Method in class org.lsst.ccs.shell.util.EmptyMultiMap

putAll(MultiMap<K, V>) - Method in interface org.lsst.ccs.shell.util.MultiMap

R

readCommand(List<String>) - Method in class org.lsst.ccs.shell.ConsoleIO

readCommand(List<String>) - Method in interface org.lsst.ccs.shell.Input

remove(K, V) - Method in class org.lsst.ccs.shell.util.ArrayHashMultiMap

remove(K, V) - Method in class org.lsst.ccs.shell.util.EmptyMultiMap

remove(K, V) - Method in interface org.lsst.ccs.shell.util.MultiMap

removeAll(K) - Method in class org.lsst.ccs.shell.util.ArrayHashMultiMap

removeAll(K) - Method in class org.lsst.ccs.shell.util.EmptyMultiMap

removeAll(K) - Method in interface org.lsst.ccs.shell.util.MultiMap

removeConverter(InputConverter) - Method in class org.lsst.ccs.shell.InputConversionEngine

removeConverter(OutputConverter) - Method in class org.lsst.ccs.shell.OutputConversionEngine

runScript(String) - Method in class org.lsst.ccs.shell.ConsoleIO

S

setAbbreviation(String) - Method in class org.lsst.ccs.shell.ShellCommand

setAppName(String) - Method in class org.lsst.ccs.shell.Shell

Hint is some text displayed before the command loop and every time user enters "?".

setCommandTable(CommandTable) - Method in class org.lsst.ccs.shell.ConsoleIO

setDescription(String) - Method in class org.lsst.ccs.shell.ShellCommand

setDisplayTime(boolean) - Method in class org.lsst.ccs.shell.Shell

Turns command execution time display on and off

setHeader(String) - Method in class org.lsst.ccs.shell.ShellCommand

setParamSpecs(ShellCommandParamSpec[]) - Method in class org.lsst.ccs.shell.ShellCommand

setSettings(Shell.Settings) - Method in class org.lsst.ccs.shell.Shell

Shell - Class in org.lsst.ccs.shell

Shell is the class interacting with user.

Shell(Shell.Settings, CommandTable, List<String>) - Constructor for class org.lsst.ccs.shell.Shell

Shell's constructor You probably don't need this one, see methods of the ShellFactory.

Shell.Settings - Class in org.lsst.ccs.shell

Shell.Settings(Input, Output, MultiMap, boolean) - Constructor for class org.lsst.ccs.shell.Shell.Settings

ShellCommand - Class in org.lsst.ccs.shell

Command table entry

ShellCommand(String, String) - Constructor for class org.lsst.ccs.shell.ShellCommand

ShellCommandParamSpec - Class in org.lsst.ccs.shell

Specification of command's parameters, such as description given with Param annotation.

ShellCommandParamSpec(String, Class, String, int) - Constructor for class org.lsst.ccs.shell.ShellCommandParamSpec

ShellDependent - Interface in org.lsst.ccs.shell

Classes that want to have an instance of Shell associated with them should implement this interface.

ShellFactory - Class in org.lsst.ccs.shell

ShellManageable - Interface in org.lsst.ccs.shell

This interface is for classes that want to be aware of entering and leaving each command loop.

size() - Method in class org.lsst.ccs.shell.util.ArrayHashMultiMap

size() - Method in class org.lsst.ccs.shell.util.EmptyMultiMap

size() - Method in interface org.lsst.ccs.shell.util.MultiMap

splitJavaIdentifier(String) - Static method in class org.lsst.ccs.shell.util.Strings

Rather clever function.

startsWith(String) - Method in class org.lsst.ccs.shell.ShellCommand

Strings - Class in org.lsst.ccs.shell.util

Procedural class with static public methods for string handling.

Strings() - Constructor for class org.lsst.ccs.shell.util.Strings

T

Token - Class in org.lsst.ccs.shell

Token associates index of a token in the input line with the token itself, in order to be able to provide helpful error indecation (see below :) ------------------------------------------------^ Misspelled word! (Exactly how it should work).

Token(int, String) - Constructor for class org.lsst.ccs.shell.Token

TokenException - Exception in org.lsst.ccs.shell

Exception pointing at the token which caused it.

TokenException(Token) - Constructor for exception org.lsst.ccs.shell.TokenException

TokenException(Token, String) - Constructor for exception org.lsst.ccs.shell.TokenException

TokenException(Token, Throwable) - Constructor for exception org.lsst.ccs.shell.TokenException

TokenException(Token, String, Throwable) - Constructor for exception org.lsst.ccs.shell.TokenException

toString() - Method in class org.lsst.ccs.shell.CommandNamer.NamingInfo

toString() - Method in class org.lsst.ccs.shell.ShellCommand

toString() - Method in class org.lsst.ccs.shell.Token

toString() - Method in class org.lsst.ccs.shell.util.ArrayHashMultiMap

toString() - Method in class org.lsst.ccs.shell.util.EmptyMultiMap

A C D E F G H I J K L M N O P R S T