at.tuwien.ifs.somtoolbox.apps.config

Class AbstractOptionFactory

java.lang.Object

at.tuwien.ifs.somtoolbox.apps.config.AbstractOptionFactory

Direct Known Subclasses:

OptionFactory

public class AbstractOptionFactory
extends java.lang.Object

This class provides methods for commonly used JSAP options, such as registering of parameters and parsing of arguments, including printing of a usage if needed.
Using the parameters provided in OptionFactory, your need for JSAP API usage should be reduced to something like this:
Parameter[] OPTIONS = { OptionFactory.getOpt...(), OptionFactory.getOpt...(), ... };
JSAPResult config = OptionFactory.parseResults(args, OPTIONS);

Version:

$Id: AbstractOptionFactory.java 4283 2014-01-05 17:27:43Z mayer $

Author:

Rudolf Mayer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	AbstractOptionFactory.FieldComparator
private static class	AbstractOptionFactory.MethodComparator

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.logging.Logger	logger

Constructor Summary

Constructors

Constructor and Description
AbstractOptionFactory()

Method Summary

Modifier and Type	Method and Description
private static void	checkDuplicates(java.util.HashMap<com.martiansoftware.jsap.Parameter,java.lang.String> map, com.martiansoftware.jsap.Parameter parameter, java.lang.String propertyName, java.lang.Character propertyValue)
private static void	checkDuplicates(java.util.HashMap<com.martiansoftware.jsap.Parameter,java.lang.String> map, com.martiansoftware.jsap.Parameter parameter, java.lang.String propertyName, java.lang.String propertyValue)
static void	checkLoggerInitialised()
private static void	checkParamter(java.util.HashMap<com.martiansoftware.jsap.Parameter,java.lang.String> shortFlags, java.util.HashMap<com.martiansoftware.jsap.Parameter,java.lang.String> longFlags, java.util.HashMap<com.martiansoftware.jsap.Parameter,java.lang.String> ids, com.martiansoftware.jsap.Parameter parameter)
private static java.lang.String	computeClassName()
protected static java.util.ArrayList<com.martiansoftware.jsap.Parameter>	findDuplicates(java.util.HashMap<com.martiansoftware.jsap.Parameter,?> map, java.lang.Object value)
static java.lang.String	getFilePath(com.martiansoftware.jsap.JSAPResult config, java.lang.String id)
protected static com.martiansoftware.jsap.stringparsers.FileStringParser	getInputDirectoryParser()
static com.martiansoftware.jsap.stringparsers.FileStringParser	getInputFileParser()
static com.martiansoftware.jsap.stringparsers.FileStringParser	getInputFileParser(java.lang.String... extension)
protected static com.martiansoftware.jsap.stringparsers.FileStringParser	getOuputFileParser()
protected static com.martiansoftware.jsap.stringparsers.FileStringParser	getOutputDirectoryParser()
static com.martiansoftware.jsap.stringparsers.EnumeratedStringParser	makeEnumeratedStringParser(java.lang.String... validOptionValues)
static com.martiansoftware.jsap.JSAPResult	parseResults(java.lang.Class<?> callingClass, java.lang.String[] args, boolean printParameterValues, com.martiansoftware.jsap.Parameter... options)
static com.martiansoftware.jsap.JSAPResult	parseResults(java.lang.Class<?> callingClass, java.lang.String[] args, com.martiansoftware.jsap.Parameter... options)
static com.martiansoftware.jsap.JSAPResult	parseResults(java.lang.String[] args, boolean printParameterValues, com.martiansoftware.jsap.Parameter... options)
static com.martiansoftware.jsap.JSAPResult	parseResults(java.lang.String[] args, com.martiansoftware.jsap.JSAP jsap)
static com.martiansoftware.jsap.JSAPResult	parseResults(java.lang.String[] args, com.martiansoftware.jsap.JSAP jsap, java.lang.String className)
static com.martiansoftware.jsap.JSAPResult	parseResults(java.lang.String[] args, com.martiansoftware.jsap.Parameter... options)
static void	printHelp(com.martiansoftware.jsap.JSAP jsap, java.lang.String className, java.io.PrintStream outStream)
static void	printUsage(com.martiansoftware.jsap.JSAP jsap, java.lang.String className, com.martiansoftware.jsap.JSAPResult config, java.lang.String errorMessage)
private static void	printVersion(java.lang.String className)
static void	registerOptions(com.martiansoftware.jsap.JSAP jsap, com.martiansoftware.jsap.Parameter[] options) Register a given set of options to the given JSAP object.
static com.martiansoftware.jsap.JSAP	registerOptions(com.martiansoftware.jsap.Parameter[] options)
protected static void	testDuplicateOptions(java.lang.Object o)
static java.lang.String	toString(com.martiansoftware.jsap.JSAPResult result, com.martiansoftware.jsap.Parameter[] options)

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static java.util.logging.Logger logger

Constructor Detail

AbstractOptionFactory

public AbstractOptionFactory()

Method Detail

makeEnumeratedStringParser

public static com.martiansoftware.jsap.stringparsers.EnumeratedStringParser makeEnumeratedStringParser(java.lang.String... validOptionValues)

parseResults

public static com.martiansoftware.jsap.JSAPResult parseResults(java.lang.Class<?> callingClass,
                                                               java.lang.String[] args,
                                                               com.martiansoftware.jsap.Parameter... options)

parseResults

public static com.martiansoftware.jsap.JSAPResult parseResults(java.lang.Class<?> callingClass,
                                                               java.lang.String[] args,
                                                               boolean printParameterValues,
                                                               com.martiansoftware.jsap.Parameter... options)

parseResults

public static com.martiansoftware.jsap.JSAPResult parseResults(java.lang.String[] args,
                                                               com.martiansoftware.jsap.JSAP jsap)

parseResults

public static com.martiansoftware.jsap.JSAPResult parseResults(java.lang.String[] args,
                                                               com.martiansoftware.jsap.Parameter... options)

parseResults

public static com.martiansoftware.jsap.JSAPResult parseResults(java.lang.String[] args,
                                                               boolean printParameterValues,
                                                               com.martiansoftware.jsap.Parameter... options)

parseResults

public static com.martiansoftware.jsap.JSAPResult parseResults(java.lang.String[] args,
                                                               com.martiansoftware.jsap.JSAP jsap,
                                                               java.lang.String className)

toString

public static java.lang.String toString(com.martiansoftware.jsap.JSAPResult result,
                                        com.martiansoftware.jsap.Parameter[] options)

computeClassName

private static java.lang.String computeClassName()

printUsage

public static void printUsage(com.martiansoftware.jsap.JSAP jsap,
                              java.lang.String className,
                              com.martiansoftware.jsap.JSAPResult config,
                              java.lang.String errorMessage)

printHelp

public static void printHelp(com.martiansoftware.jsap.JSAP jsap,
                             java.lang.String className,
                             java.io.PrintStream outStream)

printVersion

private static void printVersion(java.lang.String className)

registerOptions

public static void registerOptions(com.martiansoftware.jsap.JSAP jsap,
                                   com.martiansoftware.jsap.Parameter[] options)

Register a given set of options to the given JSAP object.

Parameters:

jsap - The JSAP to register options to.

options - The options to register.

registerOptions

public static com.martiansoftware.jsap.JSAP registerOptions(com.martiansoftware.jsap.Parameter[] options)

getFilePath

public static java.lang.String getFilePath(com.martiansoftware.jsap.JSAPResult config,
                                           java.lang.String id)

getOuputFileParser

protected static com.martiansoftware.jsap.stringparsers.FileStringParser getOuputFileParser()

getInputFileParser

public static com.martiansoftware.jsap.stringparsers.FileStringParser getInputFileParser()

getInputFileParser

public static com.martiansoftware.jsap.stringparsers.FileStringParser getInputFileParser(java.lang.String... extension)

getOutputDirectoryParser

protected static com.martiansoftware.jsap.stringparsers.FileStringParser getOutputDirectoryParser()

getInputDirectoryParser

protected static com.martiansoftware.jsap.stringparsers.FileStringParser getInputDirectoryParser()

testDuplicateOptions

protected static void testDuplicateOptions(java.lang.Object o)

checkParamter

private static void checkParamter(java.util.HashMap<com.martiansoftware.jsap.Parameter,java.lang.String> shortFlags,
                                  java.util.HashMap<com.martiansoftware.jsap.Parameter,java.lang.String> longFlags,
                                  java.util.HashMap<com.martiansoftware.jsap.Parameter,java.lang.String> ids,
                                  com.martiansoftware.jsap.Parameter parameter)

checkLoggerInitialised

public static void checkLoggerInitialised()

checkDuplicates

private static void checkDuplicates(java.util.HashMap<com.martiansoftware.jsap.Parameter,java.lang.String> map,
                                    com.martiansoftware.jsap.Parameter parameter,
                                    java.lang.String propertyName,
                                    java.lang.Character propertyValue)

checkDuplicates

private static void checkDuplicates(java.util.HashMap<com.martiansoftware.jsap.Parameter,java.lang.String> map,
                                    com.martiansoftware.jsap.Parameter parameter,
                                    java.lang.String propertyName,
                                    java.lang.String propertyValue)

findDuplicates

protected static java.util.ArrayList<com.martiansoftware.jsap.Parameter> findDuplicates(java.util.HashMap<com.martiansoftware.jsap.Parameter,?> map,
                                                                                        java.lang.Object value)