org.lsst.ccs.command.demo

Class DemoCommands

java.lang.Object

org.lsst.ccs.command.demo.DemoCommands

All Implemented Interfaces:

DemoInterface

Direct Known Subclasses:

ExtendedDemoCommands

public class DemoCommands
extends Object
implements DemoInterface

A class designed to illustrate how a class can be annotated to accept commands. Note that the only dependencies this class has is on the annotations package.

Author:

The CCS Team

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DemoCommands.Day
static class	DemoCommands.Holiday
static class	DemoCommands.Number

Constructor Summary

Constructors

Constructor and Description
DemoCommands()

Method Summary

Modifier and Type	Method and Description
double	add(double a, double b)
double	addAll(String base, double... numbers)
int	dayOfWeek(DemoCommands.Day day)
String	echoWithOptions(Options opts, String input)
String	echoWithVarArgs(String... input)
void	error()
double	getTemperature(int module)
void	longCommand()
String	xcommandWithLotsOfEnumParameters(DemoCommands.Day day, DemoCommands.Number number, DemoCommands.Holiday holiday)
int	zcommandWithDefault(int value)
String	zcommandWithEmptyDefault(String prefix, String post)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.lsst.ccs.command.demo.DemoInterface

echo

Constructor Detail

DemoCommands

public DemoCommands()

Method Detail

getTemperature

@Command(description="Get the temperature of a module",
         alias="gt")
public double getTemperature(@Argument(name="module",description="module (0-9)")
                                                                                                          int module)

add

@Command(description="Add two arguments")
public double add(double a,
                                                            double b)

addAll

@Command(description="Add any number of arguments")
public double addAll(String base,
                                                                         double... numbers)

dayOfWeek

@Command(description="Convert day of week to an ordinal",
         alias="dow, day")
public int dayOfWeek(@Argument(name="Day")
                                                                                                          DemoCommands.Day day)

error

@Command(description="Always generates an error")
public void error()

longCommand

@Command(name="ACrazyLongNameToTestIfHelpFormatingWorks",
         description="A very long command that does nothing",
         level=1)
public void longCommand()

zcommandWithDefault

@Command(name="zcommandWithDefault",
         description="A Command with an argument with default value")
public int zcommandWithDefault(@Argument(name="arg",defaultValue="1")
                                                                                                                                          int value)

zcommandWithEmptyDefault

@Command(name="zcommandWithEmptyDefault",
         description="A Command with an argument with empty default value")
public String zcommandWithEmptyDefault(@Argument(name="prefix")
                                                                                                                                                             String prefix,
                                                                                                                                                             @Argument(name="arg",defaultValue="")
                                                                                                                                                             String post)

xcommandWithLotsOfEnumParameters

@Command(name="xcommandWithLotsOfEnumParameters",
         description="A Command lots of enum parameters")
public String xcommandWithLotsOfEnumParameters(@Argument(name="Day")
                                                                                                                                                           DemoCommands.Day day,
                                                                                                                                                           @Argument(name="number")
                                                                                                                                                           DemoCommands.Number number,
                                                                                                                                                           @Argument(name="Holiday")
                                                                                                                                                           DemoCommands.Holiday holiday)

echoWithOptions

@Option(name="invert") @Option(name="uppercase") @Option(name="space")
 @Command(description="A Command with Options")
public String echoWithOptions(Options opts,
                                                                                                                                                     String input)

echoWithVarArgs

@Command(description="A Command with Options")
public String echoWithVarArgs(String... input)