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

A

add(Dictionary) - Method in class org.lsst.ccs.command.CompositeCommandDictionary

add(CommandSet) - Method in class org.lsst.ccs.command.CompositeCommandSet

Add a new command set

add(double, double) - Method in class org.lsst.ccs.command.demo.DemoCommands

add(double, double) - Method in class org.lsst.ccs.command.demo.ExtendedDemoCommands

addAll(String, double...) - Method in class org.lsst.ccs.command.demo.DemoCommands

AmbiguousCommandException - Exception in org.lsst.ccs.command

Thrown if two command targets are found which are ambiguous.

Argument - Annotation Type in org.lsst.ccs.command.annotations

Annotation for parameters of Command-marked methods.

B

BasicCommand - Interface in org.lsst.ccs.command

A interface implemented by both TokenizedCommand and RawCommand

buildCommandSet(Object) - Method in class org.lsst.ccs.command.CommandSetBuilder

Build a command set from an objects annotations.

BuiltIns() - Constructor for class org.lsst.ccs.command.RouteSelectionCommandSet.BuiltIns

BuiltIns() - Constructor for class org.lsst.ccs.shell.JLineShell.BuiltIns

C

Command - Annotation Type in org.lsst.ccs.command.annotations

Annotation for commands.

Command.CommandCategory - Enum in org.lsst.ccs.command.annotations

Command.CommandType - Enum in org.lsst.ccs.command.annotations

CommandArgumentMatchException - Exception in org.lsst.ccs.command

An exception thrown when a command Argument does not match the provided values.

CommandArgumentMatchException(String) - Constructor for exception org.lsst.ccs.command.CommandArgumentMatchException

CommandClient - Interface in org.lsst.ccs.command.remote

A CommandSet which acts as a proxy for a remote CommandServer.

CommandDictionaryBuilder - Class in org.lsst.ccs.command

This class consists of a CommandDictionary plus a map of which methods should be called as a result of each command.

CommandDictionaryBuilder(Class) - Constructor for class org.lsst.ccs.command.CommandDictionaryBuilder

Build a command dictionary for the given class.

CommandInvocationException - Exception in org.lsst.ccs.command

An exception thrown when a command invocation fails, either because the command cannot be invoked, or because it was invoked and generated an exception.

CommandInvocationException(String, Throwable, Object...) - Constructor for exception org.lsst.ccs.command.CommandInvocationException

CommandInvocationException(String, Object...) - Constructor for exception org.lsst.ccs.command.CommandInvocationException

CommandInvocationException(String, Throwable) - Constructor for exception org.lsst.ccs.command.CommandInvocationException

CommandInvocationException(InvocationTargetException) - Constructor for exception org.lsst.ccs.command.CommandInvocationException

CommandResponse - Class in org.lsst.ccs.command.remote

The result of invoking a command on a remote server.

CommandResponse(Serializable) - Constructor for class org.lsst.ccs.command.remote.CommandResponse

CommandResponse(CommandInvocationException) - Constructor for class org.lsst.ccs.command.remote.CommandResponse

CommandServer - Class in org.lsst.ccs.command.remote

A command server which waits to receive commands from a remote client

CommandServer(CommandSet) - Constructor for class org.lsst.ccs.command.remote.CommandServer

CommandSet - Interface in org.lsst.ccs.command

A CommandSet is a combination of a Dictionary plus the ability to invoke a command.

CommandSetBuilder - Class in org.lsst.ccs.command

Takes a single object and builds a command set from its annotated methods.

CommandSetBuilder() - Constructor for class org.lsst.ccs.command.CommandSetBuilder

complete(String, int, List<CharSequence>) - Method in interface org.lsst.ccs.command.DictionaryCompleter

Generate a list of possible command completions.

CompositeCommandDictionary - Class in org.lsst.ccs.command

A command dictionary to which other command dictionaries can be added and removed.

CompositeCommandDictionary() - Constructor for class org.lsst.ccs.command.CompositeCommandDictionary

CompositeCommandSet - Class in org.lsst.ccs.command

A class which can combine multiple command sets to form one combined command set.

CompositeCommandSet() - Constructor for class org.lsst.ccs.command.CompositeCommandSet

connect(int) - Method in class org.lsst.ccs.command.demo.RCMReg

containsCommand(BasicCommand) - Method in class org.lsst.ccs.command.CompositeCommandDictionary

containsCommand(BasicCommand) - Method in interface org.lsst.ccs.command.Dictionary

Test if a given command is present in a dictionary.

D

dayOfWeek(DemoCommands.Day) - Method in class org.lsst.ccs.command.demo.DemoCommands

DemoCommands - Class in org.lsst.ccs.command.demo

A class designed to illustrate how a class can be annotated to accept commands.

DemoCommands() - Constructor for class org.lsst.ccs.command.demo.DemoCommands

DemoCommands.Day - Enum in org.lsst.ccs.command.demo

DemoCommands.Holiday - Enum in org.lsst.ccs.command.demo

DemoCommands.Number - Enum in org.lsst.ccs.command.demo

DemoCommandsWithComplexArgs - Class in org.lsst.ccs.command.demo

A class designed to illustrate commands with complex arguments: Arrays, Lists and Maps

DemoCommandsWithComplexArgs() - Constructor for class org.lsst.ccs.command.demo.DemoCommandsWithComplexArgs

Dictionary - Interface in org.lsst.ccs.command

A command dictionary contains all the information needed to provide help and perform tab completion.

DictionaryArgument - Interface in org.lsst.ccs.command

Encapsulate the dictionary information about a single argument.

DictionaryCommand - Interface in org.lsst.ccs.command

Encapsulate the dictionary information for a single command and parameters.

DictionaryCompleter - Interface in org.lsst.ccs.command

Performs command completion, based on the information available in the command dictionary.

DictionaryHelpGenerator - Interface in org.lsst.ccs.command

An interface to be implemented by classes providing Help Support for DictionaryCommands.

DictionaryUtils - Class in org.lsst.ccs.command

A set of utilities for dealing with command dictionaries.

DictionaryUtils() - Constructor for class org.lsst.ccs.command.DictionaryUtils

doSomething(OverloadingCommands.What, int) - Method in class org.lsst.ccs.command.demo.OverloadingCommands

doSomething(OverloadingCommands.What, int, int) - Method in class org.lsst.ccs.command.demo.OverloadingCommands

doSomething(OverloadingCommands.What, int, int, OverloadingCommands.When) - Method in class org.lsst.ccs.command.demo.OverloadingCommands

E

ENGINEERING1 - Static variable in annotation type org.lsst.ccs.command.annotations.Command

ENGINEERING2 - Static variable in annotation type org.lsst.ccs.command.annotations.Command

ENGINEERING3 - Static variable in annotation type org.lsst.ccs.command.annotations.Command

error() - Method in class org.lsst.ccs.command.demo.DemoCommands

exit() - Method in class org.lsst.ccs.shell.JLineShell.BuiltIns

ExtendedDemoCommands - Class in org.lsst.ccs.command.demo

Class to test extending a class providing commands

ExtendedDemoCommands() - Constructor for class org.lsst.ccs.command.demo.ExtendedDemoCommands

F

findCommand(BasicCommand) - Method in class org.lsst.ccs.command.CompositeCommandDictionary

findCommand(BasicCommand) - Method in interface org.lsst.ccs.command.Dictionary

Find a given command in the dictionary

G

get(RouteSelectionCommandSet.SetGetCommands) - Method in class org.lsst.ccs.command.RouteSelectionCommandSet.BuiltIns

getAliases() - Method in interface org.lsst.ccs.command.DictionaryCommand

Get the array of aliases for this command.

getAllowedValues() - Method in interface org.lsst.ccs.command.DictionaryArgument

Get the list of allowed values for this DictionaryArgument.

getAllowedValues() - Method in class org.lsst.ccs.command.HelpGenerator

getAllowedValues() - Method in class org.lsst.ccs.command.RouteSelectionCommandSet

getArgument(int) - Method in interface org.lsst.ccs.command.BasicCommand

getArgument(int) - Method in class org.lsst.ccs.command.RawCommand

Get a specific command argument

getArgument(int) - Method in class org.lsst.ccs.command.TokenizedCommand

Get a specific command argument

getArgumentCount() - Method in interface org.lsst.ccs.command.BasicCommand

Get the number of arguments associated with this command

getArgumentCount() - Method in class org.lsst.ccs.command.RawCommand

Get the number of arguments associated with this command

getArgumentCount() - Method in class org.lsst.ccs.command.TokenizedCommand

Get the number of arguments associated with this command

getArguments() - Method in interface org.lsst.ccs.command.BasicCommand

getArguments() - Method in interface org.lsst.ccs.command.DictionaryCommand

Get the array of DictionaryArgument for this DictionaryCommand.

getArguments() - Method in class org.lsst.ccs.command.RawCommand

getArguments() - Method in class org.lsst.ccs.command.TokenizedCommand

getCategory() - Method in interface org.lsst.ccs.command.DictionaryCommand

Get the CommandCategory for this DictionaryCommand.

getCommand() - Method in interface org.lsst.ccs.command.BasicCommand

Get the root command name (the zeroth token)

getCommand() - Method in class org.lsst.ccs.command.RawCommand

Get the root command name (the zeroth token)

getCommand() - Method in class org.lsst.ccs.command.TokenizedCommand

Get the root command name (the zeroth token)

getCommandDictionary() - Method in class org.lsst.ccs.command.CommandDictionaryBuilder

Get the command dictionary.

getCommandDictionary() - Method in interface org.lsst.ccs.command.CommandSet

getCommandDictionary() - Method in class org.lsst.ccs.command.CompositeCommandSet

Get the dictionary associated with this command set.

getCommandDictionary() - Method in class org.lsst.ccs.command.RoutingCommandSet

getCommandName() - Method in interface org.lsst.ccs.command.DictionaryCommand

Get the name of the DictionaryCommand.

getCommandSet() - Method in class org.lsst.ccs.command.HelpGenerator

Return the command set containing the HelpCommands themselves.

getCommandSet() - Method in class org.lsst.ccs.command.remote.CommandServer

getCommandSets() - Method in class org.lsst.ccs.command.CompositeCommandSet

Returns the list of command sets.

getDefaultValue() - Method in interface org.lsst.ccs.command.DictionaryArgument

getDescription() - Method in interface org.lsst.ccs.command.DictionaryArgument

getDescription() - Method in interface org.lsst.ccs.command.DictionaryCommand

Get the description for this DictionaryCommand.

getDictionaryCompleter() - Method in class org.lsst.ccs.command.CompositeCommandDictionary

getDictionaryCompleter() - Method in interface org.lsst.ccs.command.Dictionary

Get the DictionaryCompleter for this Dictionary.

getHelpGenerator() - Method in class org.lsst.ccs.command.CompositeCommandDictionary

getHelpGenerator() - Method in interface org.lsst.ccs.command.Dictionary

Get the DictionaryHelpGenerator for this Dictionary.

getLevel() - Method in interface org.lsst.ccs.command.DictionaryCommand

Get the level for this DictionaryCommand.

getName() - Method in interface org.lsst.ccs.command.DictionaryArgument

getResult() - Method in class org.lsst.ccs.command.remote.CommandResponse

getSimpleType() - Method in interface org.lsst.ccs.command.DictionaryArgument

Get the simple type of this parameter

getTemperature(int) - Method in class org.lsst.ccs.command.demo.DemoCommands

getTimeout() - Method in interface org.lsst.ccs.command.DictionaryCommand

Returns the default timeout value associated with this command.

getType() - Method in interface org.lsst.ccs.command.DictionaryArgument

Get the type of this parameter

getType() - Method in interface org.lsst.ccs.command.DictionaryCommand

Get the CommandType for this DictionaryCommand.

H

hasHelp(DictionaryCommand) - Method in interface org.lsst.ccs.command.DictionaryHelpGenerator

Check if help support is provided for the given command.

HelpGenerator - Class in org.lsst.ccs.command

Provides help based on information from a command dictionary.

HelpGenerator(PrintWriter, Dictionary) - Constructor for class org.lsst.ccs.command.HelpGenerator

Create a HelpGenerator

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

I

invoke(BasicCommand) - Method in interface org.lsst.ccs.command.CommandSet

invoke(BasicCommand) - Method in class org.lsst.ccs.command.CompositeCommandSet

Invoke a command included in this command set.

invoke(BasicCommand) - Method in class org.lsst.ccs.command.RoutingCommandSet

isAutoAck() - Method in interface org.lsst.ccs.command.DictionaryCommand

Returns true if the ACK should be automatically sent by the framework before invoking this command.

isEmpty() - Method in class org.lsst.ccs.command.TokenizedCommand

Test if the command is completely empty (no tokens)

isVarArgs() - Method in interface org.lsst.ccs.command.DictionaryCommand

Determine if this DictionaryCommand has a variable number of arguments.

iterator() - Method in class org.lsst.ccs.command.CompositeCommandDictionary

J

JLineShell - Class in org.lsst.ccs.shell

A simple shell for playing with the command parsing classes.

JLineShell(CommandSet) - Constructor for class org.lsst.ccs.shell.JLineShell

Creates a JLineShell with the given set of user commands.

JLineShell(CommandSet, ConsoleReader) - Constructor for class org.lsst.ccs.shell.JLineShell

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

JLineShell(CommandSet, ConsoleReader, String) - Constructor for class org.lsst.ccs.shell.JLineShell

JLineShell.BuiltIns - Class in org.lsst.ccs.shell

The set of built in commands.

JLineShell.SetCommands - Enum in org.lsst.ccs.shell

An enumeration of the arguments to the set command.

L

longCommand() - Method in class org.lsst.ccs.command.demo.DemoCommands

M

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

Temporary method waiting for feedback.

matchesCommandOrAlias(String) - Method in interface org.lsst.ccs.command.DictionaryCommand

Test if value matches this command (either the command itself or one if its aliases).

modifyHelpForCommand(DictionaryCommand, String, boolean) - Method in interface org.lsst.ccs.command.DictionaryHelpGenerator

Modify the current help for the command.

N

NO_ALIASES - Static variable in interface org.lsst.ccs.command.DictionaryCommand

NORMAL - Static variable in annotation type org.lsst.ccs.command.annotations.Command

NULL - Static variable in annotation type org.lsst.ccs.command.annotations.Argument

O

org.lsst.ccs.command - package org.lsst.ccs.command

An experimental package for testing possible improvements to the command handling mechanism built-in to the CCS core.

org.lsst.ccs.command.annotations - package org.lsst.ccs.command.annotations

Annotations used to mark methods as invocable by the command framework.

org.lsst.ccs.command.demo - package org.lsst.ccs.command.demo

Examples of annotated classes providing command functionality.

org.lsst.ccs.command.remote - package org.lsst.ccs.command.remote

Abstract classes required for remote command invocation.

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

A toy JLine based shell for testing the command system.

OverloadingCommands - Class in org.lsst.ccs.command.demo

A class with overloading annotated commands

OverloadingCommands() - Constructor for class org.lsst.ccs.command.demo.OverloadingCommands

OverloadingCommands.What - Enum in org.lsst.ccs.command.demo

OverloadingCommands.When - Enum in org.lsst.ccs.command.demo

P

prettyToString() - Method in interface org.lsst.ccs.command.BasicCommand

R

RawCommand - Class in org.lsst.ccs.command

A command with pre-parsed arguments (Objects).

RawCommand(String, List<Object>) - Constructor for class org.lsst.ccs.command.RawCommand

Builds a Raw Command.

RCMReg - Class in org.lsst.ccs.command.demo

Demo to test the Java RCM register access routines.

RCMReg() - Constructor for class org.lsst.ccs.command.demo.RCMReg

read(int, int) - Method in class org.lsst.ccs.command.demo.RCMReg

remove(Dictionary) - Method in class org.lsst.ccs.command.CompositeCommandDictionary

remove(CommandSet) - Method in class org.lsst.ccs.command.CompositeCommandSet

Remove a command set

RouteSelectionCommandSet - Class in org.lsst.ccs.command

A CommandSet that acts as a filter and deals with changing the active route.

RouteSelectionCommandSet(CompositeCommandSet) - Constructor for class org.lsst.ccs.command.RouteSelectionCommandSet

RouteSelectionCommandSet.BuiltIns - Class in org.lsst.ccs.command

RouteSelectionCommandSet.SetGetCommands - Enum in org.lsst.ccs.command

RoutingCommandSet - Class in org.lsst.ccs.command

A CompositeCommandSet that provides a route to activate another CommandSet.

RoutingCommandSet(String, CommandSet) - Constructor for class org.lsst.ccs.command.RoutingCommandSet

run() - Method in class org.lsst.ccs.shell.JLineShell

Run the command shell.

S

set(RouteSelectionCommandSet.SetGetCommands, String) - Method in class org.lsst.ccs.command.RouteSelectionCommandSet.BuiltIns

set(JLineShell.SetCommands, String) - Method in class org.lsst.ccs.shell.JLineShell.BuiltIns

show() - Method in class org.lsst.ccs.command.demo.RCMReg

size() - Method in class org.lsst.ccs.command.CompositeCommandDictionary

size() - Method in interface org.lsst.ccs.command.Dictionary

The size of the dictionary.

stacktrace() - Method in class org.lsst.ccs.shell.JLineShell.BuiltIns

subtract(double, double) - Method in class org.lsst.ccs.command.demo.ExtendedDemoCommands

sumArray(int[]) - Method in class org.lsst.ccs.command.demo.DemoCommandsWithComplexArgs

sumList(List<Integer>) - Method in class org.lsst.ccs.command.demo.DemoCommandsWithComplexArgs

sumListOfList(List<List<Integer>>) - Method in class org.lsst.ccs.command.demo.DemoCommandsWithComplexArgs

sumMap(Map<Integer, String>) - Method in class org.lsst.ccs.command.demo.DemoCommandsWithComplexArgs

T

throwExceptionIfNeeded(List<CommandArgumentMatchException>) - Static method in exception org.lsst.ccs.command.CommandArgumentMatchException

TokenizedCommand - Class in org.lsst.ccs.command

A command line that has been split into tokens.

TokenizedCommand(String) - Constructor for class org.lsst.ccs.command.TokenizedCommand

Builds a Tokenized command from an unparsed string.

toString() - Method in class org.lsst.ccs.command.RawCommand

toString() - Method in class org.lsst.ccs.command.TokenizedCommand

V

valueOf(String) - Static method in enum org.lsst.ccs.command.annotations.Command.CommandCategory

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

valueOf(String) - Static method in enum org.lsst.ccs.command.annotations.Command.CommandType

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

valueOf(String) - Static method in enum org.lsst.ccs.command.demo.DemoCommands.Day

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

valueOf(String) - Static method in enum org.lsst.ccs.command.demo.DemoCommands.Holiday

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

valueOf(String) - Static method in enum org.lsst.ccs.command.demo.DemoCommands.Number

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

valueOf(String) - Static method in enum org.lsst.ccs.command.demo.OverloadingCommands.What

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

valueOf(String) - Static method in enum org.lsst.ccs.command.demo.OverloadingCommands.When

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

valueOf(String) - Static method in enum org.lsst.ccs.command.RouteSelectionCommandSet.SetGetCommands

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

valueOf(String) - Static method in enum org.lsst.ccs.shell.JLineShell.SetCommands

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

values() - Static method in enum org.lsst.ccs.command.annotations.Command.CommandCategory

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

values() - Static method in enum org.lsst.ccs.command.annotations.Command.CommandType

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

values() - Static method in enum org.lsst.ccs.command.demo.DemoCommands.Day

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

values() - Static method in enum org.lsst.ccs.command.demo.DemoCommands.Holiday

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

values() - Static method in enum org.lsst.ccs.command.demo.DemoCommands.Number

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

values() - Static method in enum org.lsst.ccs.command.demo.OverloadingCommands.What

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

values() - Static method in enum org.lsst.ccs.command.demo.OverloadingCommands.When

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

values() - Static method in enum org.lsst.ccs.command.RouteSelectionCommandSet.SetGetCommands

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

values() - Static method in enum org.lsst.ccs.shell.JLineShell.SetCommands

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

W

write(int, int[]) - Method in class org.lsst.ccs.command.demo.RCMReg

X

xcommandWithLotsOfEnumParameters(DemoCommands.Day, DemoCommands.Number, DemoCommands.Holiday) - Method in class org.lsst.ccs.command.demo.DemoCommands

Z

zcommandWithDefault(int) - Method in class org.lsst.ccs.command.demo.DemoCommands

zcommandWithEmptyDefault(String, String) - Method in class org.lsst.ccs.command.demo.DemoCommands

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