org.fuin.kickstart4j
Class CmdLineParser

java.lang.Object
  org.fuin.kickstart4j.CmdLineParser

public final class CmdLineParser
extends Object

Parses the command line and set the appropriate config object values.

Constructor Summary

CmdLineParser(Locale locale)
Constructor with locale.

Method Summary

void	copyToConfig(Config config) Copy the parsed values to the configuration.
String	get(String key) Returns an option value by it's key.
static void	main(String[] args) Test method.
void	parse(String[] args) Parse the command line and set the values in the target config object.
void	printUsage(OutputStream out) Prints the command line usage.
void	printUsage(PrintStream ps) Prints the command line usage.
String	remove(String key) Removes an option key.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CmdLineParser

public CmdLineParser(Locale locale)

Constructor with locale.

Parameters:

locale - Locale.

Method Detail

parse

public final void parse(String[] args)
                 throws CmdLineException

Parse the command line and set the values in the target config object.

Parameters:

args - Command line arguments.

Throws:

CmdLineException - Illegal arguments or missing required arguments.

get

public String get(String key)

Returns an option value by it's key.

Parameters:

key - Key to find.

Returns:

Value or null if the key was not found.

remove

public String remove(String key)

Removes an option key.

Parameters:

key - Option to remove.

Returns:

Previously removed value.

copyToConfig

public void copyToConfig(Config config)

Copy the parsed values to the configuration.

Parameters:

config - Config to fill with parsed values.

printUsage

public final void printUsage(PrintStream ps)

Prints the command line usage.

Parameters:

ps - Stream to use.

printUsage

public final void printUsage(OutputStream out)

Prints the command line usage.

Parameters:

out - Stream to use.

toString

public final String toString()

Overrides:

toString in class Object

main

public static void main(String[] args)

Test method.

Parameters:

args - Not used.