fabric.common

Class Options.Flag

java.lang.Object

fabric.common.Options.Flag

All Implemented Interfaces:

java.lang.Comparable<Options.Flag>

Enclosing class:

Options

public abstract static class Options.Flag
extends java.lang.Object
implements java.lang.Comparable<Options.Flag>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Options.Flag.Kind

Field Summary

Fields

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 Summary

Constructors

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)

Method Summary

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.

Methods inherited from class java.lang.Object

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

Field Detail

kind

protected final Options.Flag.Kind kind

ids

protected final java.util.Set<java.lang.String> ids

params

protected final java.lang.String params

usage

protected final java.lang.String usage

Constructor Detail

Flag

public Flag(java.lang.String id,
            java.lang.String params,
            java.lang.String usage)

Parameters:

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

Flag

public Flag(java.lang.String id,
            java.lang.String params,
            java.lang.String usage,
            int defaultValue)

Parameters:

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.

Flag

public Flag(java.lang.String id,
            java.lang.String params,
            java.lang.String usage,
            java.lang.String defaultValue)

Parameters:

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.

Flag

public Flag(java.lang.String[] ids,
            java.lang.String params,
            java.lang.String usage)

Parameters:

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

Flag

public Flag(java.lang.String[] ids,
            java.lang.String params,
            java.lang.String usage,
            int defaultValue)

Parameters:

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.

Flag

public Flag(java.lang.String[] ids,
            java.lang.String params,
            java.lang.String usage,
            java.lang.String defaultValue)

Parameters:

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.

Flag

public Flag(Options.Flag.Kind kind,
            java.lang.String id,
            java.lang.String params,
            java.lang.String usage)

Parameters:

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

Flag

public Flag(Options.Flag.Kind kind,
            java.lang.String id,
            java.lang.String params,
            java.lang.String usage,
            int defaultValue)

Parameters:

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.

Flag

public Flag(Options.Flag.Kind kind,
            java.lang.String id,
            java.lang.String params,
            java.lang.String usage,
            java.lang.String defaultValue)

Parameters:

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.

Flag

public Flag(Options.Flag.Kind kind,
            java.lang.String[] ids,
            java.lang.String params,
            java.lang.String usage)

Parameters:

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

Flag

public Flag(Options.Flag.Kind kind,
            java.lang.String[] ids,
            java.lang.String params,
            java.lang.String usage,
            int defaultValue)

Parameters:

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.

Flag

public Flag(Options.Flag.Kind kind,
            java.lang.String[] ids,
            java.lang.String params,
            java.lang.String usage,
            java.lang.String defaultValue)

Parameters:

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.

Method Detail

handle

public abstract int handle(java.lang.String[] args,
                           int index)
                    throws UsageError

Handles a usage flag.

Parameters:

args - Arguments from the command line.

index - The index of the argument following the usage flag.

Returns:

The next index to be processed. e.g., if calling this method processes two arguments, then the return value should be index+2.

Throws:

UsageError - If an error occurs while handling the usage flag.

compareTo

public int compareTo(Options.Flag other)

Specified by:

compareTo in interface java.lang.Comparable<Options.Flag>

printUsage

public void printUsage(java.io.PrintStream out)

Outputs this flag and a description of its usage in a nice format.

Parameters:

out - output PrintStream