polyglot.main

Class OptFlag<T>

java.lang.Object

polyglot.main.OptFlag<T>

Type Parameters:

T - The type of value parsed by this option.

All Implemented Interfaces:

java.lang.Comparable<OptFlag<T>>

Direct Known Subclasses:

OptFlag.DoubleFlag, OptFlag.IntFlag, OptFlag.PathFlag, OptFlag.Switch

public abstract class OptFlag<T>
extends java.lang.Object
implements java.lang.Comparable<OptFlag<T>>

An OptFlag represents a command line option. It groups parsing and usage information together so that compilers may easily compose options from multiple extensions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OptFlag.Arg<T> An argument parsed from the command line.
static class	OptFlag.DoubleFlag A Flag that accepts a integer param.
static class	OptFlag.IntFlag A Flag that accepts a integer param.
static class	OptFlag.Kind
static class	OptFlag.PathFlag<T> A OptFlag that accepts a string param with entries separated by the path separator.
static class	OptFlag.Switch A Flag that acts as a boolean switch.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	defaultValue
protected java.util.Set<java.lang.String>	ids
protected OptFlag.Kind	kind
protected java.lang.String	params
protected java.lang.String	usage

Constructor Summary

Constructors

Constructor and Description
OptFlag(OptFlag.Kind kind, java.lang.String[] ids, java.lang.String params, java.lang.String usage)
OptFlag(OptFlag.Kind kind, java.lang.String[] ids, java.lang.String params, java.lang.String usage, int defaultValue)
OptFlag(OptFlag.Kind kind, java.lang.String[] ids, java.lang.String params, java.lang.String usage, java.lang.String defaultValue)
OptFlag(OptFlag.Kind kind, java.lang.String id, java.lang.String params, java.lang.String usage)
OptFlag(OptFlag.Kind kind, java.lang.String id, java.lang.String params, java.lang.String usage, int defaultValue)
OptFlag(OptFlag.Kind kind, java.lang.String id, java.lang.String params, java.lang.String usage, java.lang.String defaultValue)
OptFlag(java.lang.String[] ids, java.lang.String params, java.lang.String usage)
OptFlag(java.lang.String[] ids, java.lang.String params, java.lang.String usage, int defaultValue)
OptFlag(java.lang.String[] ids, java.lang.String params, java.lang.String usage, java.lang.String defaultValue)
OptFlag(java.lang.String id, java.lang.String params, java.lang.String usage)
OptFlag(java.lang.String id, java.lang.String params, java.lang.String usage, int defaultValue)
OptFlag(java.lang.String id, java.lang.String params, java.lang.String usage, java.lang.String defaultValue)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(OptFlag<T> flag)
OptFlag.Arg<T>	createArg(int next, T value)
OptFlag.Arg<T>	createDefault(T value)
OptFlag.Arg<T>	defaultArg()
OptFlag.Arg<T>	defaultArg(java.util.List<OptFlag.Arg<?>> arguments)
boolean	equals(java.lang.Object obj)
abstract OptFlag.Arg<T>	handle(java.lang.String[] args, int index) Handles a usage flag.
int	hashCode()
static boolean	hasSourceArg(java.util.List<OptFlag.Arg<?>> arguments)
java.util.Set<java.lang.String>	ids()
OptFlag.Kind	kind()
static OptFlag.Arg<?>	lookup(java.lang.String id, java.util.List<OptFlag.Arg<?>> args)
static java.util.List<OptFlag.Arg<?>>	lookupAll(java.lang.String id, java.util.List<OptFlag.Arg<?>> args)
static OptFlag<?>	lookupFlag(java.lang.String id, java.util.Set<OptFlag<?>> flags) Lookup the flag matching id
void	printUsage(java.io.PrintStream out) Outputs this flag and a description of its usage in a nice format.
static boolean	removeFlag(java.lang.String id, java.util.Set<OptFlag<?>> flags) Remove the flag matching id
static java.util.List<OptFlag.Arg<?>>	sourceArgs(java.util.List<OptFlag.Arg<?>> arguments)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

kind

protected final OptFlag.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

defaultValue

protected final java.lang.String defaultValue

Constructor Detail

OptFlag

public OptFlag(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."

OptFlag

public OptFlag(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.

OptFlag

public OptFlag(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.

OptFlag

public OptFlag(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."

OptFlag

public OptFlag(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.

OptFlag

public OptFlag(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.

OptFlag

public OptFlag(OptFlag.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."

OptFlag

public OptFlag(OptFlag.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.

OptFlag

public OptFlag(OptFlag.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.

OptFlag

public OptFlag(OptFlag.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."

OptFlag

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

Parameters:

ids - OptFlag 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.

OptFlag

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

Parameters:

ids - OptFlag 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

removeFlag

public static boolean removeFlag(java.lang.String id,
                 java.util.Set<OptFlag<?>> flags)

Remove the flag matching id

Parameters:

id - command line flag of the OptFlag to remove

flags - the list of OptFlags

Returns:

true if the id was found

lookupFlag

public static OptFlag<?> lookupFlag(java.lang.String id,
                    java.util.Set<OptFlag<?>> flags)

Lookup the flag matching id

Parameters:

id - command line flag of the OptFlag

flags - the list of OptFlags

Returns:

true if the id was found

hasSourceArg

public static boolean hasSourceArg(java.util.List<OptFlag.Arg<?>> arguments)

sourceArgs

public static java.util.List<OptFlag.Arg<?>> sourceArgs(java.util.List<OptFlag.Arg<?>> arguments)

lookup

public static OptFlag.Arg<?> lookup(java.lang.String id,
                    java.util.List<OptFlag.Arg<?>> args)

lookupAll

public static java.util.List<OptFlag.Arg<?>> lookupAll(java.lang.String id,
                                       java.util.List<OptFlag.Arg<?>> args)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(OptFlag<T> flag)

Specified by:

compareTo in interface java.lang.Comparable<OptFlag<T>>

kind

public OptFlag.Kind kind()

ids

public java.util.Set<java.lang.String> ids()

handle

public abstract OptFlag.Arg<T> 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.

defaultArg

public OptFlag.Arg<T> defaultArg(java.util.List<OptFlag.Arg<?>> arguments)

defaultArg

public OptFlag.Arg<T> defaultArg()

createArg

public OptFlag.Arg<T> createArg(int next,
                       T value)

createDefault

public OptFlag.Arg<T> createDefault(T value)

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