Package tech.units.indriya

Class AbstractSystemOfUnits

java.lang.Object

tech.units.indriya.AbstractSystemOfUnits

All Implemented Interfaces:

SystemOfUnits, tech.uom.lib.common.function.Nameable

Direct Known Subclasses:

Units

public abstract class AbstractSystemOfUnits
extends Object
implements SystemOfUnits, tech.uom.lib.common.function.Nameable

An abstract base class for unit systems.

Since:

1.0

Version:

2.3, November 23, 2024

Author:

Werner Keil

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractSystemOfUnits.Helper	Static helper class.

Field Summary

Fields

Modifier and Type	Field	Description
protected static Logger	logger
protected Map<Class<? extends Quantity>,Unit>	quantityToUnit	Holds the mapping quantity to unit.
protected Set<Unit<?>>	units	Holds the units.

Constructor Summary

Constructors

Constructor	Description
AbstractSystemOfUnits()

Method Summary

Modifier and Type	Method	Description
abstract String	getName()
<Q extends Quantity<Q>> Unit<Q>	getUnit(Class<Q> quantityType)
Unit<?>	getUnit(String string)
Unit<?>	getUnit(String string, UnitStyle style)	Returns a unit with the given string representation in a particular style or null if none is found in this unit system and requested style.
Unit<?>	getUnit(String string, UnitStyle style, boolean ignoreCase)	Returns a unit with the given string representation in a particular style or null if none is found in this unit system and requested style.
Set<Unit<?>>	getUnits()
Set<? extends Unit<?>>	getUnits(Dimension dimension)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final Logger logger

units

protected final Set<Unit<?>> units

Holds the units.

quantityToUnit

protected final Map<Class<? extends Quantity>,Unit> quantityToUnit

Holds the mapping quantity to unit.

Constructor Detail

AbstractSystemOfUnits

public AbstractSystemOfUnits()

Method Detail

getName

public abstract String getName()

Specified by:

getName in interface tech.uom.lib.common.function.Nameable

Specified by:

getName in interface SystemOfUnits

getUnits

public Set<Unit<?>> getUnits()

Specified by:

getUnits in interface SystemOfUnits

getUnits

public Set<? extends Unit<?>> getUnits(Dimension dimension)

Specified by:

getUnits in interface SystemOfUnits

getUnit

public <Q extends Quantity<Q>> Unit<Q> getUnit(Class<Q> quantityType)

Specified by:

getUnit in interface SystemOfUnits

getUnit

public Unit<?> getUnit(String string)

Specified by:

getUnit in interface SystemOfUnits

getUnit

public Unit<?> getUnit(String string,
                       UnitStyle style,
                       boolean ignoreCase)

Returns a unit with the given string representation in a particular style or null if none is found in this unit system and requested style.

NOTE: Use ignoreCase carefully, as it will find the FIRST unit for a particular string, e.g. the symbol of SECOND and SIEMENS would be the same without case, but the UPPERCASE letter sorted first.

Parameters:

string - the string representation of a unit, not null.

style - the style of unit representation.

ignoreCase - ignore the case or not?

Returns:

the unit with the given string representation.

Since:

2.0

getUnit

public Unit<?> getUnit(String string,
                       UnitStyle style)

Returns a unit with the given string representation in a particular style or null if none is found in this unit system and requested style.

Parameters:

string - the string representation of a unit, not null.

style - the style of unit representation.

Returns:

the unit with the given string representation.

Since:

2.0