org.salespointframework.quantity

Class Metric

java.lang.Object

org.salespointframework.quantity.Metric

All Implemented Interfaces:

Serializable

public class Metric
extends Object
implements Serializable

Immutable metric representation. A metric consists of a name, a symbol and a description.

Author:

Hannes Weisbach

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Metric(String name, String symbol) Class constructor specifying name and symbol.
Metric(String name, String symbol, String definition) Class constructor specifying name, symbol and definition.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Compares this Metric to obj.
String	getDefinition() Returns the String containing the definition of this metric.
String	getName() Returns the name of this metric.
String	getSymbol() Returns the symbol of this metric.
int	hashcode() Returns a hash code for this Metric object.
int	hashCode()
String	toString() Returns a string representation of this Metric object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Metric

public Metric(String name,
              String symbol,
              String definition)

Class constructor specifying name, symbol and definition.

Parameters:

name - the name of the metric, for example 'meter'

symbol - symbol used to represent the metric, for example 'm'

definition - definition of the metric, i.e. 'the base unit of length in the International System of Units'

Metric

public Metric(String name,
              String symbol)

Class constructor specifying name and symbol.

Parameters:

name - the name of the metric, for example 'meter'

symbol - the symbol representing the metric, for example 'm'

Method Detail

getName

public String getName()

Returns the name of this metric.

Returns:

the name of this metric.

getSymbol

public String getSymbol()

Returns the symbol of this metric.

Returns:

the symbol of this metric.

getDefinition

public String getDefinition()

Returns the String containing the definition of this metric. The String may be empty, but is non-null.

Returns:

the definition of this metric.

equals

public boolean equals(Object obj)

Compares this Metric to obj. Returns false if obj is not an instance of Metric. Otherwise, two Metrics are equal, if their symbols and names are equal.

Overrides:

equals in class Object

Parameters:

obj - the Object to which this is compared.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hashcode

public final int hashcode()

Returns a hash code for this Metric object. The result is exclusive OR of the hash code of the name and the hash code of the symbol.

Returns:

a hash code for this Metric object.

toString

public String toString()

Returns a string representation of this Metric object. The symbol is used to represent a Metric object as string.

Overrides:

toString in class Object