ucar.units

Class PrefixDBImpl

java.lang.Object

ucar.units.PrefixDBImpl

All Implemented Interfaces:

java.io.Serializable, PrefixDB

Direct Known Subclasses:

StandardPrefixDB

public class PrefixDBImpl
extends java.lang.Object
implements PrefixDB, java.io.Serializable

Provides a concrete implementation of a database of unit prefixes. Instances of this class are modifiable.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PrefixDBImpl() Constructs from nothing.

Method Summary

Modifier and Type	Method and Description
void	addName(java.lang.String name, double value) Adds a prefix to the database by name.
void	addSymbol(java.lang.String symbol, double value) Adds a prefix symbol to the database.
Prefix	getPrefixByName(java.lang.String string) Gets a prefix by name.
Prefix	getPrefixBySymbol(java.lang.String string) Gets a prefix by symbol.
Prefix	getPrefixByValue(double value) Gets a prefix by value.
java.util.Iterator<Prefix>	iterator() Gets an iterator over the prefixes in the database.
java.lang.String	toString() Returns a string representation of this database.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrefixDBImpl

public PrefixDBImpl()

Constructs from nothing.

Method Detail

addName

public void addName(java.lang.String name,
                    double value)
             throws PrefixExistsException

Adds a prefix to the database by name.

Specified by:

addName in interface PrefixDB

Parameters:

name - The name of the prefix to be added.

value - The value of the prefix.

Throws:

PrefixExistsException - Another prefix with the same name or value already exists in the database.

addSymbol

public void addSymbol(java.lang.String symbol,
                      double value)
               throws PrefixExistsException

Adds a prefix symbol to the database.

Specified by:

addSymbol in interface PrefixDB

Parameters:

symbol - The symbol of the prefix to be added.

value - The value of the prefix.

Throws:

PrefixExistsException - Another prefix with the same symbol or value already exists in the database.

getPrefixByName

public Prefix getPrefixByName(java.lang.String string)

Gets a prefix by name.

Specified by:

getPrefixByName in interface PrefixDB

Parameters:

string - The name to be matched.

Returns:

The prefix whose name matches or null.

getPrefixBySymbol

public Prefix getPrefixBySymbol(java.lang.String string)

Gets a prefix by symbol.

Specified by:

getPrefixBySymbol in interface PrefixDB

Parameters:

string - The symbol to be matched.

Returns:

The prefix whose symbol matches or null.

getPrefixByValue

public Prefix getPrefixByValue(double value)

Gets a prefix by value.

Specified by:

getPrefixByValue in interface PrefixDB

Parameters:

value - The value to be matched.

Returns:

The prefix whose value matches or null.

toString

public java.lang.String toString()

Returns a string representation of this database.

Specified by:

toString in interface PrefixDB

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this database.

iterator

public java.util.Iterator<Prefix> iterator()

Gets an iterator over the prefixes in the database.

Specified by:

iterator in interface PrefixDB

Returns:

An iterator over the entries in the database. The objects returned by the iterator will be of type Prefix.