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

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

add(String, CommandSet) - Method in class org.lsst.ccs.command.RoutingCommandSet

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

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.

C

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

Annotation for commands.

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

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.

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 class 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(String, int) - 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.

containsCommand(String, int) - Method in interface org.lsst.ccs.command.Dictionary

Test if a given command is present in a dictionary

convertArgToType(String, Class) - Method in class org.lsst.ccs.command.InputConversionEngine

Convert the input string to an object of the given class

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

DictionariesTree - Class in org.lsst.ccs.command

Client codes can receive a complete Tree of DictionaryContext from a Subsystem.

DictionariesTree(TreeBranch<DictionaryContext>) - Constructor for class org.lsst.ccs.command.DictionariesTree

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 - Class in org.lsst.ccs.command

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

DictionaryCompleter(Dictionary) - Constructor for class org.lsst.ccs.command.DictionaryCompleter

Create a command completer for the given dictionary.

DictionaryContext - Class in org.lsst.ccs.command

DictionaryContext(String, Dictionary) - Constructor for class org.lsst.ccs.command.DictionaryContext

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

factory(Class) - Static method in class org.lsst.ccs.command.LocalBuilders

* this factory gets a LocalCommandDictionary which might be in a local cache.

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

findCommand(String, int) - 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

findCommand(String, int) - Method in interface org.lsst.ccs.command.Dictionary

Find a given command in the dictionary.

G

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

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.DictionaryCommand

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

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 interface org.lsst.ccs.command.LocalCommandDictionary

Gets the command dictionary.

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

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

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.

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

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

getDictionary() - Method in class org.lsst.ccs.command.DictionaryContext

getDictionaryFor(String) - Method in class org.lsst.ccs.command.DictionariesTree

gets a Dictionary linked to a Component.

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

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

Find the method which should be invoked as a result of a particular command.

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

Finds a Method which is linked to a DictionaryCommand.

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

Finds the method which should be invoked as a result of a particular command.

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

* Finds a Method which is linked to a DictionaryCommand.

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

getMethods() - Method in interface org.lsst.ccs.command.LocalCommandDictionary

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

getName() - Method in class org.lsst.ccs.command.DictionaryContext

getNodeFor(String) - Method in class org.lsst.ccs.command.DictionariesTree

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

getTopNode() - Method in class org.lsst.ccs.command.DictionariesTree

Since the TreeBranch class is a TreeNode this method is useful for GUIs in need of a JTree.

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

Get the type of this parameter

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

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

H

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

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

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

InputConversionEngine - Class in org.lsst.ccs.command

This class is responsible for converting strings to objects of a particular class.

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

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

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

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

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

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.BuiltIns() - Constructor for class org.lsst.ccs.shell.JLineShell.BuiltIns

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

An enumeration of the arguments to the set command.

L

LocalBuilders - Class in org.lsst.ccs.command

static utilities to handle LocalCommandDictionary

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

LocalCommandDictionary - Interface in org.lsst.ccs.command

interface to define a "Local" Command Dictionary on a per-class basis.

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 of its aliases).

N

namesIterator() - Method in class org.lsst.ccs.command.DictionariesTree

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.

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

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

RoutingCommandSet - Class in org.lsst.ccs.command

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

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

Run the command shell.

S

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

T

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.

toRawCommand(String, Method) - Static method in class org.lsst.ccs.command.LocalBuilders

converts an unparsed command into a command that can be invoked

toRawCommand(TokenizedCommand, Method) - Static method in class org.lsst.ccs.command.LocalBuilders

toRawCommand(BasicCommand, Method, InputConversionEngine) - Static method in class org.lsst.ccs.command.RawCommand

Convert a BasicCommand to a RawCommand.

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

V

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.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.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.shell.JLineShell.SetCommands

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

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