me.mervinz.jargser

Class ArgumentParser

java.lang.Object

me.mervinz.jargser.ArgumentParser

public class ArgumentParser
extends Object

Argument Parser

Author:

Mervin

Constructor Summary

Constructors

Constructor and Description
ArgumentParser()

Method Summary

Modifier and Type	Method and Description
ArgumentParser	addCommand(String command, String desc) Add command setting to parser
ArgumentParser	addOption(String s, String flag, String desc) Add option setting to parser
ArgumentParser	addOption(String s, String flag, String desc, String defaultValue) Add option setting to parser with default value
boolean	hasParsedOption(String flag) Check option exist
void	parse(String[] args) Parse command and option from argument string array
String	parsedCommand() Return command which parsed by Parser
String	parsedCommandValue() Return value of command
String	parsedOption(String flag) Return value of specified flag.
void	printUsage() Print useage info
ArgumentParser	setAppName(String appName) Setup name of app
ArgumentParser	setAppVersion(String appVersion) Setup version of app
String	usage() Generate usage info

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgumentParser

public ArgumentParser()

Method Detail

setAppName

public ArgumentParser setAppName(String appName)

Setup name of app

Parameters:

appName - name

Returns:

instance of parser

setAppVersion

public ArgumentParser setAppVersion(String appVersion)

Setup version of app

Parameters:

appVersion - version

Returns:

instance of parser

addCommand

public ArgumentParser addCommand(String command,
                                 String desc)

Add command setting to parser

Parameters:

command - command

desc - description

Returns:

instance of parser

addOption

public ArgumentParser addOption(String s,
                                String flag,
                                String desc)

Add option setting to parser

Parameters:

s - short flag

flag - flag

desc - description

Returns:

instance of parser

addOption

public ArgumentParser addOption(String s,
                                String flag,
                                String desc,
                                String defaultValue)

Add option setting to parser with default value

Parameters:

s - short flag

flag - flag

desc - description

defaultValue - default value

Returns:

instance of parser

parse

public void parse(String[] args)

Parse command and option from argument string array

Parameters:

args - array

parsedOption

public String parsedOption(String flag)

Return value of specified flag.

Parameters:

flag - option flag

Returns:

value

parsedCommand

public String parsedCommand()

Return command which parsed by Parser

Returns:

command

parsedCommandValue

public String parsedCommandValue()

Return value of command

Returns:

value

hasParsedOption

public boolean hasParsedOption(String flag)

Check option exist

Parameters:

flag - option flag

Returns:

true or false

printUsage

public void printUsage()

Print useage info

usage

public String usage()

Generate usage info

Returns:

string include usage info