com.hp.util.syntax

Class Parameters

java.lang.Object

com.hp.util.syntax.Parameters

public class Parameters
extends Object

Class to keep track of all serializable parameter objects parsed from the command line arguments.

Some parameters can be marked as indexed, which means that there can be more than one specified on the command-line. Such parameters can be accessed using an index between 0 and the number of parameter occurrences, where the index value corresponds to the order in which they were specified on the command line.

Author:

Thomas Vachuska

Constructor Summary

Constructors

Constructor and Description
Parameters() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Parameters parameters) Adds all bindings from the given parameter map to this parameter map.
void	add(String name, Serializable object, boolean isIndexed) Adds the specified name/object binding to the parameter map.
Serializable	get(String name) Returns the parameter object associated with the parameter name.
Serializable	get(String name, int index) Returns the indexed parameter object associated with the parameter name.
List<Object>	getList(String name) Get list of values associated with the specified indexed parameter name.
List<String>	getNames() Returns an unmodifiable set of all parameters names in this map.
int	getOccurrences(String name) Returns the number of occurrences of the given indexed parameter.
boolean	isIndexed(String name) Returns true if the given parameter values are indexed.
boolean	isPresent(String name) Determines whether a parameter with the specified name is present.
int	size() Get the count of the parameters.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameters

public Parameters()

Default constructor.

Method Detail

size

public int size()

Get the count of the parameters.

Returns:

Count of parameters in the map

isPresent

public boolean isPresent(String name)

Determines whether a parameter with the specified name is present.

Parameters:

name - Name of the parameter whose presence we are testing.

Returns:

True if the parameter is present; false otherwise.

isIndexed

public boolean isIndexed(String name)

Returns true if the given parameter values are indexed.

Parameters:

name - Name of the parameter.

Returns:

True if the parameter is indexed; false otherwise.

getOccurrences

public int getOccurrences(String name)

Returns the number of occurrences of the given indexed parameter.

Parameters:

name - Name of the parameter whose presence we are testing.

Returns:

Number of times the indexed parameter is present in the map or 1 if the parameter is not indexed.

get

public Serializable get(String name)

Returns the parameter object associated with the parameter name.

Parameters:

name - Name of the parameter.

Returns:

Serializable value mapped to the parameter name.

get

public Serializable get(String name,
               int index)

Returns the indexed parameter object associated with the parameter name.

Parameters:

name - Name of the parameter.

index - Index (starting with 0), of the value associated with the parameter name.

Returns:

Serializable value mapped to the parameter name.

getList

public List<Object> getList(String name)

Get list of values associated with the specified indexed parameter name. Values are put on the list in the order in which they were specified on the command-line.

Parameters:

name - Name of the indexed parameter.

Returns:

List of serializable values mapped to the indexed parameter name.

add

public void add(String name,
       Serializable object,
       boolean isIndexed)

Adds the specified name/object binding to the parameter map.

Parameters:

name - Name of the parameter.

object - Serializable value to be mapped to the parameter name.

isIndexed - True if the parameter value is to be marked as indexed, i.e. there could be more than one value associated with the given parameter name.

add

public void add(Parameters parameters)

Adds all bindings from the given parameter map to this parameter map. Parameters with the same name (and index) override the existing value.

Parameters:

parameters - The parameters map whose name/object bindings are to be imported to this map.

getNames

public List<String> getNames()

Returns an unmodifiable set of all parameters names in this map.

Returns:

Set of parameter names.

toString

public String toString()

Overrides:

toString in class Object