Class CmdLineParser

java.lang.Object

com.github.rjeschke.txtmark.cmd.CmdLineParser

final class CmdLineParser
extends Object

Generic command line parser. This is a copy from

invalid @link

{@link https://github.com/rjeschke/neetutils-base

}.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	CmdLineParser.Arg
private static final class	CmdLineParser.Classes
private static final class	CmdLineParser.Colls
private static class	CmdLineParser.Once<T>
private static final class	CmdLineParser.Strings
(package private) static enum	CmdLineParser.Type

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final HashSet<String>	BOOL_FALSE
(package private) static final HashSet<String>	BOOL_TRUE
(package private) static final Class<?>[]	TYPE_CLASS_LIST
(package private) static final HashMap<Class<?>, CmdLineParser.Type>	TYPE_MAP
(package private) static final CmdLineParser.Type[]	TYPE_TYPE_LIST

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CmdLineParser()

Method Summary

Modifier and Type	Method	Description
(package private) static String	defaultToString(Object value, CmdLineParser.Type type, CmdLineParser.Arg arg)
static String	generateHelp(int columnWidth, boolean sort, Object... objs)	Generates a formatted help (Unix-style) for the given argument objects.
(package private) static CmdLineParser.Type	getTypeFor(Class<?> clazz)
static List<String>	parse(String[] args, Object... objs)	Parses command line arguments.
private static void	parseArgs(Object[] objs, List<CmdLineParser.Arg> allArgs, HashMap<String, CmdLineParser.Arg> shortArgs, HashMap<String, CmdLineParser.Arg> longArgs)

Methods inherited from class Object

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

Field Details

TYPE_MAP

static final HashMap<Class<?>, CmdLineParser.Type> TYPE_MAP

TYPE_CLASS_LIST

static final Class<?>[] TYPE_CLASS_LIST

TYPE_TYPE_LIST

static final CmdLineParser.Type[] TYPE_TYPE_LIST

BOOL_TRUE

static final HashSet<String> BOOL_TRUE

BOOL_FALSE

static final HashSet<String> BOOL_FALSE

Constructor Details

CmdLineParser

private CmdLineParser()

Method Details

getTypeFor

static CmdLineParser.Type getTypeFor(Class<?> clazz)

defaultToString

static String defaultToString(Object value,
 CmdLineParser.Type type,
 CmdLineParser.Arg arg)

parseArgs

private static void parseArgs(Object[] objs,
 List<CmdLineParser.Arg> allArgs,
 HashMap<String, CmdLineParser.Arg> shortArgs,
 HashMap<String, CmdLineParser.Arg> longArgs)
                       throws IOException

Throws:

IOException

generateHelp

public static String generateHelp(int columnWidth,
 boolean sort,
 Object... objs)
                           throws IOException

Generates a formatted help (Unix-style) for the given argument objects.

Parameters:

columnWidth - Maximum column width. Words get wrapped at spaces.

sort - Set true to sort arguments before printing.

objs - One or more objects with annotated public fields.

Returns:

The formatted argument help text.

Throws:

IOException - if a parsing error occurred.

See Also:

• CmdArgument

parse

public static List<String> parse(String[] args,
 Object... objs)
                          throws IOException

Parses command line arguments.

Parameters:

args - Array of arguments, like the ones provided by void main(String[] args)

objs - One or more objects with annotated public fields.

Returns:

A List containing all unparsed arguments (i.e. arguments that are no switches)

Throws:

IOException - if a parsing error occurred.

See Also:

• CmdArgument