Class ArgumentParser

java.lang.Object

me.pauleff.common.argparse.ArgumentParser

public final class ArgumentParser
extends Object

Parses command-line arguments into a ParseResult for this application.

Handles help and version requests as terminal exits, configures logging verbosity, and applies custom UUID API options when present.

Constructor Summary

Constructors

Constructor	Description
ArgumentParser(String appName, String version)	Creates a parser for the given application name and version string.

Method Summary

Modifier and Type	Method	Description
ParseResult	parse(String[] args)	Parses the given command-line arguments and returns a ParseResult.
void	printHelp()	Prints usage help for the configured CLI options to standard output.

Methods inherited from class Object

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

Constructor Details

ArgumentParser

public ArgumentParser(String appName,
 String version)

Creates a parser for the given application name and version string.

Parameters:

appName - the application name shown in help and version output

version - the application version shown with the -v flag

Method Details

printHelp

public void printHelp()

Prints usage help for the configured CLI options to standard output.

parse

public ParseResult parse(String[] args)

Parses the given command-line arguments and returns a ParseResult.

On success, returns ParseResult.success(ParsedArguments). Help or version requests return ParseResult.exit(int) with code 0. Parse failures print help and return an exit result with code 1.

Parameters:

args - the raw command-line arguments

Returns:

a successful result with ParsedArguments, or a terminal exit result