org.apache.reef.tang.formats

Class CommandLine

java.lang.Object

org.apache.reef.tang.formats.CommandLine

public final class CommandLine
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CommandLine.CommandLineCallback

Constructor Summary

Constructors

Constructor and Description
CommandLine()
CommandLine(ConfigurationBuilder conf)

Method Summary

Methods

Modifier and Type	Method and Description
CommandLine	addCommandLineOption(org.apache.commons.cli.Option option, CommandLine.CommandLineCallback cb)
ConfigurationBuilder	getBuilder()
static Configuration	parseToConfiguration(String[] args, Class<? extends Name<?>>... argClasses) Utility method to quickly parse a command line to a Configuration.
static ConfigurationBuilder	parseToConfigurationBuilder(String[] args, Class<? extends Name<?>>... argClasses) Utility method to quickly parse a command line to a ConfigurationBuilder.
<T> CommandLine	processCommandLine(String[] args, Class<? extends Name<?>>... argClasses) Process command line arguments.
CommandLine	registerShortNameOfClass(Class<? extends Name<?>> c)
CommandLine	registerShortNameOfClass(String s)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLine

public CommandLine()

CommandLine

public CommandLine(ConfigurationBuilder conf)

Method Detail

getBuilder

public ConfigurationBuilder getBuilder()

registerShortNameOfClass

public CommandLine registerShortNameOfClass(String s)
                                     throws BindException

Throws:

BindException

registerShortNameOfClass

public CommandLine registerShortNameOfClass(Class<? extends Name<?>> c)
                                     throws BindException

Throws:

BindException

addCommandLineOption

public CommandLine addCommandLineOption(org.apache.commons.cli.Option option,
                               CommandLine.CommandLineCallback cb)

processCommandLine

@SafeVarargs
public final <T> CommandLine processCommandLine(String[] args,
                                             Class<? extends Name<?>>... argClasses)
                                     throws IOException,
                                            BindException

Process command line arguments.

Type Parameters:

T - a type

Parameters:

args - the command line arguments to be parsed

argClasses - the target named classes to be set

Returns:

Selfie if the command line parsing succeeded, null (or exception) otherwise.

Throws:

IOException - if parsing fails

BindException - if a binding of short-named parameter fails

parseToConfiguration

public static Configuration parseToConfiguration(String[] args,
                                 Class<? extends Name<?>>... argClasses)
                                          throws org.apache.commons.cli.ParseException

Utility method to quickly parse a command line to a Configuration.

This is equivalent to parseToConfigurationBuilder(args, argClasses).build()

Parameters:

args - the command line parameters to parse.

argClasses - the named parameters to look for.

Returns:

a Configuration with the parsed parameters

Throws:

org.apache.commons.cli.ParseException - if the parsing of the commandline fails.

parseToConfigurationBuilder

public static ConfigurationBuilder parseToConfigurationBuilder(String[] args,
                                               Class<? extends Name<?>>... argClasses)
                                                        throws org.apache.commons.cli.ParseException

Utility method to quickly parse a command line to a ConfigurationBuilder.

This is equivalent to new CommandLine().processCommandLine(args, argClasses).getBuilder(), but with additional checks.

Parameters:

args - the command line parameters to parse.

argClasses - the named parameters to look for.

Returns:

a ConfigurationBuilder with the parsed parameters

Throws:

org.apache.commons.cli.ParseException - if the parsing of the commandline fails.