edu.umass.cs.mallet.base.util

Class CommandOption

java.lang.Object

edu.umass.cs.mallet.base.util.CommandOption

Direct Known Subclasses:

CommandOption.Boolean, CommandOption.Double, CommandOption.DoubleArray, CommandOption.File, CommandOption.Integer, CommandOption.IntegerArray, CommandOption.Object, CommandOption.Set, CommandOption.SpacedStrings, CommandOption.String

public abstract class CommandOption
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandOption.Boolean
static class	CommandOption.Double
static class	CommandOption.DoubleArray
static class	CommandOption.File
static class	CommandOption.Integer
static class	CommandOption.IntegerArray
static class	CommandOption.List
static interface	CommandOption.ListProviding For objects that can provide CommandOption.List's (which can be merged into other lists.
static class	CommandOption.Object
static class	CommandOption.Set
static class	CommandOption.SpacedStrings
static class	CommandOption.String

Constructor Summary

Constructors

Constructor and Description
CommandOption(Class owner, String name, String argName, Class argType, boolean argRequired, String shortdoc)
CommandOption(Class owner, String name, String argName, Class argType, boolean argRequired, String shortdoc, String longdoc)

Method Summary

Modifier and Type	Method and Description
abstract String	defaultValueToString()
String	getFullName()
static BshInterpreter	getInterpreter()
static CommandOption.List	getList(Class owner)
void	parseArg(String arg)
int	parseArg(String[] args, int argi) Called after this CommandOption matches an argument.
void	postParsing(CommandOption.List list) To be overridden by subclasses; "list" is the the CommandOption.List that called this option
static String[]	process(Class owner, String[] args)
int	process(String[] args, int argi) Give this CommandOption the opportunity to process the argi'th argument in args.
static void	setSummary(Class owner, String summary)
abstract String	valueToString()
boolean	wasInvoked() Return true is this CommandOption was matched by one of the processed arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandOption

public CommandOption(Class owner,
                     String name,
                     String argName,
                     Class argType,
                     boolean argRequired,
                     String shortdoc,
                     String longdoc)

CommandOption

public CommandOption(Class owner,
                     String name,
                     String argName,
                     Class argType,
                     boolean argRequired,
                     String shortdoc)

Method Detail

process

public int process(String[] args,
                   int argi)

Give this CommandOption the opportunity to process the argi'th argument in args. Return the next unprocessed index.

getInterpreter

public static BshInterpreter getInterpreter()

process

public static String[] process(Class owner,
                               String[] args)

getList

public static CommandOption.List getList(Class owner)

setSummary

public static void setSummary(Class owner,
                              String summary)

getFullName

public String getFullName()

defaultValueToString

public abstract String defaultValueToString()

valueToString

public abstract String valueToString()

wasInvoked

public boolean wasInvoked()

Return true is this CommandOption was matched by one of the processed arguments.

parseArg

public int parseArg(String[] args,
                    int argi)

Called after this CommandOption matches an argument. The default implementation simply calls parseArg(String), and returns argi+1; unless argi is negative, in which case it calls parseArg((String)null) and returns argi.

parseArg

public void parseArg(String arg)

postParsing

public void postParsing(CommandOption.List list)

To be overridden by subclasses; "list" is the the CommandOption.List that called this option