de.mhus.lib.core

Class MArgs

java.lang.Object

de.mhus.lib.core.MArgs

public class MArgs
extends Object

The class is a parser for program argument lists, like you get in the main(args) method. You can also put a usage definition to the constructor to define the possible methods. The parser will parse all arguments. If a minus is the first character the next argument will be stored under this key. A argument key can be there multiple times. If there no value after the key the key is marked as existing. A value without a key on front of it is stored under the DEFAUTL key. The "usage" feature is not finished yet!

Version:

$Id: $Id

Author:

mhu

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT Constant DEFAULT=""

Constructor Summary

Constructors

Constructor and Description
MArgs(String[] args) Use the argument array to parse arguments.
MArgs(String[] args, String[] pUsage) Constructor for MArgs.

Method Summary

Modifier and Type	Method and Description
boolean	contains(String name) Returns true if the argument list contains the key.
protected List<String>	getArgValues(String name) Returns a List of the arguments for the given key.
Set<String>	getKeys() Return a iterable set of existing keys.
int	getSize(String name) Returns the amount of attributes for this key.
String	getValue(String name, int index) Returns the "index" parameter for this key.
String	getValue(String name, String def, int index) Returns the "index" parameter for this key.
String[]	getValues(String name) Return all values for this parameter as a array.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final String DEFAULT

Constant DEFAULT=""

See Also:

Constant Field Values

Constructor Detail

MArgs

public MArgs(String[] args)

Use the argument array to parse arguments.

Parameters:

args - an array of String objects.

MArgs

public MArgs(String[] args,
             String[] pUsage)

Constructor for MArgs.

Parameters:

args - an array of String objects.

pUsage - an array of String objects.

Method Detail

contains

public boolean contains(String name)

Returns true if the argument list contains the key.

Parameters:

name - a String object.

Returns:

a boolean.

getArgValues

protected List<String> getArgValues(String name)

Returns a List of the arguments for the given key. If the key was not set it returns null. Do not change the list.

Parameters:

name - a String object.

Returns:

a List object.

getSize

public int getSize(String name)

Returns the amount of attributes for this key.

Parameters:

name - a String object.

Returns:

a int.

getValue

public String getValue(String name,
                       String def,
                       int index)

Returns the "index" parameter for this key. If the parameter is not set in this index it returns "def".

Parameters:

name - a String object.

def - a String object.

index - a int.

Returns:

a String object.

getValue

public String getValue(String name,
                       int index)

Returns the "index" parameter for this key. If the parameter is not set in this index it returns null.

Parameters:

name - a String object.

index - a int.

Returns:

a String object.

getValues

public String[] getValues(String name)

Return all values for this parameter as a array. If not set it will return an empty array.

Parameters:

name - a String object.

Returns:

an array of String objects.

getKeys

public Set<String> getKeys()

Return a iterable set of existing keys.

Returns:

a Set object.

toString

public String toString()

Overrides:

toString in class Object