public abstract static class Options.Flag extends java.lang.Object implements java.lang.Comparable<Options.Flag>
Modifier and Type | Class and Description |
---|---|
static class |
Options.Flag.Kind |
Modifier and Type | Field and Description |
---|---|
protected java.util.Set<java.lang.String> |
ids |
protected Options.Flag.Kind |
kind |
protected java.lang.String |
params |
protected java.lang.String |
usage |
Constructor and Description |
---|
Flag(Options.Flag.Kind kind,
java.lang.String[] ids,
java.lang.String params,
java.lang.String usage) |
Flag(Options.Flag.Kind kind,
java.lang.String[] ids,
java.lang.String params,
java.lang.String usage,
int defaultValue) |
Flag(Options.Flag.Kind kind,
java.lang.String[] ids,
java.lang.String params,
java.lang.String usage,
java.lang.String defaultValue) |
Flag(Options.Flag.Kind kind,
java.lang.String id,
java.lang.String params,
java.lang.String usage) |
Flag(Options.Flag.Kind kind,
java.lang.String id,
java.lang.String params,
java.lang.String usage,
int defaultValue) |
Flag(Options.Flag.Kind kind,
java.lang.String id,
java.lang.String params,
java.lang.String usage,
java.lang.String defaultValue) |
Flag(java.lang.String[] ids,
java.lang.String params,
java.lang.String usage) |
Flag(java.lang.String[] ids,
java.lang.String params,
java.lang.String usage,
int defaultValue) |
Flag(java.lang.String[] ids,
java.lang.String params,
java.lang.String usage,
java.lang.String defaultValue) |
Flag(java.lang.String id,
java.lang.String params,
java.lang.String usage) |
Flag(java.lang.String id,
java.lang.String params,
java.lang.String usage,
int defaultValue) |
Flag(java.lang.String id,
java.lang.String params,
java.lang.String usage,
java.lang.String defaultValue) |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(Options.Flag other) |
abstract int |
handle(java.lang.String[] args,
int index)
Handles a usage flag.
|
void |
printUsage(java.io.PrintStream out)
Outputs this flag and a description of its usage in a nice format.
|
protected final Options.Flag.Kind kind
protected final java.util.Set<java.lang.String> ids
protected final java.lang.String params
protected final java.lang.String usage
public Flag(java.lang.String id, java.lang.String params, java.lang.String usage)
id
- The flag ID. e.g., "--name", "-n", or "-name".params
- A string representing parameters for the flag, to be printed out
with help info. e.g., "<hostname>"usage
- Usage information, to be printed out with help info. e.g.,
"The name of the node."public Flag(java.lang.String id, java.lang.String params, java.lang.String usage, int defaultValue)
id
- The flag ID. e.g., "--name", "-n", or "-name".params
- A string representing parameters for the flag, to be printed out
with help info. e.g., "<hostname>"usage
- Usage information, to be printed out with help info. e.g.,
"The name of the node."defaultValue
- The default value for the flag parameter, to be printed out with
help info.public Flag(java.lang.String id, java.lang.String params, java.lang.String usage, java.lang.String defaultValue)
id
- The flag ID. e.g., "--name", "-n", or "-name".params
- A string representing parameters for the flag, to be printed out
with help info. e.g., "<hostname>"usage
- Usage information, to be printed out with help info. e.g.,
"The name of the node."defaultValue
- The default value(s) for the flag parameter(s), to be printed
out with help info.public Flag(java.lang.String[] ids, java.lang.String params, java.lang.String usage)
ids
- Flag IDs. e.g., { "--name", "-n", "-name"}. The first one
specified will be the one printed out with help info.params
- A string representing parameters for the flag, to be printed out
with help info. e.g., "<hostname>"usage
- Usage information, to be printed out with help info. e.g.,
"The name of the node."public Flag(java.lang.String[] ids, java.lang.String params, java.lang.String usage, int defaultValue)
ids
- Flag IDs. e.g., { "--name", "-n", "-name"}. The first one
specified will be the one printed out with help info.params
- A string representing parameters for the flag, to be printed out
with help info. e.g., "<hostname>"usage
- Usage information, to be printed out with help info. e.g.,
"The name of the node."defaultValue
- The default value for the flag parameter, to be printed out with
help info.public Flag(java.lang.String[] ids, java.lang.String params, java.lang.String usage, java.lang.String defaultValue)
ids
- Flag IDs. e.g., { "--name", "-n", "-name"}. The first one
specified will be the one printed out with help info.params
- A string representing parameters for the flag, to be printed out
with help info. e.g., "<hostname>"usage
- Usage information, to be printed out with help info. e.g.,
"The name of the node."defaultValue
- The default value(s) for the flag parameter(s), to be printed
out with help info.public Flag(Options.Flag.Kind kind, java.lang.String id, java.lang.String params, java.lang.String usage)
id
- The flag ID. e.g., "--name", "-n", or "-name".params
- A string representing parameters for the flag, to be printed out
with help info. e.g., "<hostname>"usage
- Usage information, to be printed out with help info. e.g.,
"The name of the node."public Flag(Options.Flag.Kind kind, java.lang.String id, java.lang.String params, java.lang.String usage, int defaultValue)
id
- The flag ID. e.g., "--name", "-n", or "-name".params
- A string representing parameters for the flag, to be printed out
with help info. e.g., "<hostname>"usage
- Usage information, to be printed out with help info. e.g.,
"The name of the node."defaultValue
- The default value for the flag parameter, to be printed out with
help info.public Flag(Options.Flag.Kind kind, java.lang.String id, java.lang.String params, java.lang.String usage, java.lang.String defaultValue)
id
- The flag ID. e.g., "--name", "-n", or "-name".params
- A string representing parameters for the flag, to be printed out
with help info. e.g., "<hostname>"usage
- Usage information, to be printed out with help info. e.g.,
"The name of the node."defaultValue
- The default value(s) for the flag parameter(s), to be printed
out with help info.public Flag(Options.Flag.Kind kind, java.lang.String[] ids, java.lang.String params, java.lang.String usage)
ids
- Flag IDs. e.g., { "--name", "-n", "-name"}. The first one
specified will be the one printed out with help info.params
- A string representing parameters for the flag, to be printed out
with help info. e.g., "<hostname>"usage
- Usage information, to be printed out with help info. e.g.,
"The name of the node."public Flag(Options.Flag.Kind kind, java.lang.String[] ids, java.lang.String params, java.lang.String usage, int defaultValue)
ids
- Flag IDs. e.g., { "--name", "-n", "-name"}. The first one
specified will be the one printed out with help info.params
- A string representing parameters for the flag, to be printed out
with help info. e.g., "<hostname>"usage
- Usage information, to be printed out with help info. e.g.,
"The name of the node."defaultValue
- The default value for the flag parameter, to be printed out with
help info.public Flag(Options.Flag.Kind kind, java.lang.String[] ids, java.lang.String params, java.lang.String usage, java.lang.String defaultValue)
ids
- Flag IDs. e.g., { "--name", "-n", "-name"}. The first one
specified will be the one printed out with help info.params
- A string representing parameters for the flag, to be printed out
with help info. e.g., "<hostname>"usage
- Usage information, to be printed out with help info. e.g.,
"The name of the node."defaultValue
- The default value(s) for the flag parameter(s), to be printed
out with help info.public abstract int handle(java.lang.String[] args, int index) throws UsageError
args
- Arguments from the command line.index
- The index of the argument following the usage flag.UsageError
- If an error occurs while handling the usage flag.public int compareTo(Options.Flag other)
compareTo
in interface java.lang.Comparable<Options.Flag>
public void printUsage(java.io.PrintStream out)
out
- output PrintStream