mobi.narf.recognition.configuration

Class ParameterConfiguration

java.lang.Object

mobi.narf.recognition.configuration.ParameterConfiguration

public final class ParameterConfiguration
extends java.lang.Object

This class implements a parameter specification. A parameter has a name and a value. Its type depends on its usage. The parameter specification is immutable.

Author:

Mac

Constructor Summary

Constructors

Constructor and Description
ParameterConfiguration(ParameterConfiguration parameter) Creates a copy of the parameter.
ParameterConfiguration(java.lang.String name, java.lang.String value) Creates a new parameter with the specified name.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Determines whether this parameter equals another object.
java.lang.String	getName() Returns the name of the parameter.
java.lang.String	getValue() Returns the value of the parameter.
int	hashCode() Computes a hash code for the object based on the values of the fields.
java.lang.String	toString() Returns a human readable string representation.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ParameterConfiguration

public ParameterConfiguration(java.lang.String name,
                      java.lang.String value)

Creates a new parameter with the specified name.

Parameters:

name - The name of the parameter.

value - The value of the parameter.

Throws:

java.lang.NullPointerException - Thrown if the name is null.

ParameterConfiguration

public ParameterConfiguration(ParameterConfiguration parameter)

Creates a copy of the parameter.

Parameters:

parameter - The parameter to copy.

Method Detail

getName

public java.lang.String getName()

Returns the name of the parameter.

Returns:

The name of the parameter.

getValue

public java.lang.String getValue()

Returns the value of the parameter.

Returns:

The value of the parameter.

equals

public boolean equals(java.lang.Object obj)

Determines whether this parameter equals another object. This is based on matching the name field only, i.e the value is ignored.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to match.

Returns:

True if the object equals the parameter.

hashCode

public int hashCode()

Computes a hash code for the object based on the values of the fields.

Overrides:

hashCode in class java.lang.Object

Returns:

The hash code for the parameter.

toString

public java.lang.String toString()

Returns a human readable string representation.

Overrides:

toString in class java.lang.Object

Returns:

A human readable string representation.