de.hawhamburg.reachability.util

Class ParameterUtil

java.lang.Object

de.hawhamburg.reachability.util.ParameterUtil

public final class ParameterUtil
extends java.lang.Object

Utility functions related to command line parameters.

This utility class provides some fancy methods for easy handling String parameters supplied on system call.

Version:

"2013.42"

Author:

"Malte Kantak <malte.kantak@hotmail.de>"

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.String>	parms The parameters known to this utility class.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ParameterUtil(java.util.Map<java.lang.String,java.lang.String> params) Initializes the known parameters.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	fetchBool(java.lang.String key) Returns the boolean value of a supplied key if known to the class or false instead by using fetchBool(String, boolean).
boolean	fetchBool(java.lang.String key, boolean defVal) Returns the boolean value of a supplied key if known to the class or the supplied default value instead.
int	fetchInt(java.lang.String key) Returns the int value of a supplied key if known to the class or 0 instead by using fetchInt(String, int).
int	fetchInt(java.lang.String key, int defVal) Returns the int value of a supplied key if known to the class or the supplied default value instead.
private static java.util.Map<java.lang.String,java.lang.String>	fetchParms(java.lang.String[] args, java.lang.String[] subset) Fetches a map of arguments from a system supplied argument string array which contains only the ones supplied in the subset parameter.
java.lang.String	fetchString(java.lang.String key) Returns the String value of a supplied key if known to the class or null instead by using fetchString(String, String).
java.lang.String	fetchString(java.lang.String key, java.lang.String defVal) Returns the String value of a supplied key if known to the class or the supplied default value instead.
static ParameterUtil	fromArgs(java.lang.String[] args, java.lang.String[] subset) Creates a ParameterUtil object of certain attributes from the system supplied argument string array by using fetchParms(String[], String[]).
boolean	isset(java.lang.String key) Checks whether a certain key as String is known as parameter to the current class instance or not.
boolean	someset(java.lang.String[] keys) Checks if at least one parameter of the supplied String array is known to this class instance.

Methods inherited from class java.lang.Object

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

Field Detail

parms

private java.util.Map<java.lang.String,java.lang.String> parms

The parameters known to this utility class.

Constructor Detail

ParameterUtil

private ParameterUtil(java.util.Map<java.lang.String,java.lang.String> params)

Initializes the known parameters.

Parameters:

params - The known parameters.

Method Detail

fromArgs

public static ParameterUtil fromArgs(java.lang.String[] args,
                     java.lang.String[] subset)

Creates a ParameterUtil object of certain attributes from the system supplied argument string array by using fetchParms(String[], String[]).

Parameters:

args - The system supplied argument string array.

subset - The requested subset of arguments.

Returns:

An ParameterUtil object containing the requested subset of arguments if existing.

fetchParms

private static java.util.Map<java.lang.String,java.lang.String> fetchParms(java.lang.String[] args,
                                                          java.lang.String[] subset)

Fetches a map of arguments from a system supplied argument string array which contains only the ones supplied in the subset parameter.

Parameters:

args - The system supplied argument string array.

subset - The requested subset of arguments.

Returns:

A Map of String to String containing the requested system arguments.

fetchString

public java.lang.String fetchString(java.lang.String key)

Returns the String value of a supplied key if known to the class or null instead by using fetchString(String, String).

Parameters:

key - The name of the requested argument as String.

Returns:

The value of the key if known or null instead.

fetchString

public java.lang.String fetchString(java.lang.String key,
                           java.lang.String defVal)

Returns the String value of a supplied key if known to the class or the supplied default value instead.

Parameters:

key - The name of the requested argument as String.

defVal - The default value of the argument as String, which will be returned in case the key is unknown or undefined.

Returns:

The value of the key if known or the supplied default value instead.

fetchInt

public int fetchInt(java.lang.String key)

Returns the int value of a supplied key if known to the class or 0 instead by using fetchInt(String, int).

Parameters:

key - The name of the requested argument as String.

Returns:

The value of the key if known or 0 instead.

fetchInt

public int fetchInt(java.lang.String key,
           int defVal)

Returns the int value of a supplied key if known to the class or the supplied default value instead.

Parameters:

key - The name of the requested argument as String.

defVal - The default value of the argument as int, which will be returned in case the key is unknown or undefined.

Returns:

The value of the key if known or the supplied default value instead.

fetchBool

public boolean fetchBool(java.lang.String key)

Returns the boolean value of a supplied key if known to the class or false instead by using fetchBool(String, boolean).

Parameters:

key - The name of the requested argument as String.

Returns:

The value of the key if known or false instead.

fetchBool

public boolean fetchBool(java.lang.String key,
                boolean defVal)

Returns the boolean value of a supplied key if known to the class or the supplied default value instead.

Parameters:

key - The name of the requested argument as String.

defVal - The default value of the argument as boolean, which will be returned in case the key is unknown or undefined.

Returns:

The value of the key if known or the supplied default value instead.

isset

public boolean isset(java.lang.String key)

Checks whether a certain key as String is known as parameter to the current class instance or not.

Parameters:

key - The name of the requested parameter as String.

Returns:

true if the parameter is known, otherwise false.

someset

public boolean someset(java.lang.String[] keys)

Checks if at least one parameter of the supplied String array is known to this class instance.

Parameters:

keys - A String array of parameters.

Returns:

true if at least one parameter of the supplied String array is known to this class instance, otherwise false.