uk.co.bigbeeconsultants.bconfig.data

Class DimensionedValue

java.lang.Object

uk.co.bigbeeconsultants.bconfig.data.DimensionedValue

All Implemented Interfaces:

java.lang.Comparable<DimensionedValue>

public final class DimensionedValue
extends java.lang.Object
implements java.lang.Comparable<DimensionedValue>

Holds any dimensioned value consisting of a number followed by a unit. The unit can be prefixed by a standard SI thousands-multiplier (K, M, G, T, E, m, µ, n, p, f), or by a standard IEC 2-to-the-ten multiplier (Ki, Mi, Gi, Ti). See SI for more information. Note that "k" for kilo is lowercase, following the SI convention. Instances are immutable.

Field Summary

Fields

Modifier and Type	Field and Description
java.math.BigDecimal	multiplier
java.math.BigDecimal	number
java.lang.String	unit

Method Summary

Methods

Modifier and Type	Method and Description
static DimensionedValue	apply(java.math.BigDecimal number, java.lang.String unit)
int	compareTo(DimensionedValue o)
boolean	equals(java.lang.Object o)
java.lang.String	getDisplayedMultiplier()
java.math.BigDecimal	getDisplayedNumber()
int	hashCode()
static DimensionedValue	parse(java.lang.String value) Parses a string to obtain a value.
static DimensionedValue	parse(java.lang.String value, java.lang.String exampleUnits) Parses a string to obtain a value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

number

public final java.math.BigDecimal number

multiplier

public final java.math.BigDecimal multiplier

unit

public final java.lang.String unit

Method Detail

parse

public static DimensionedValue parse(java.lang.String value,
                     java.lang.String exampleUnits)

Parses a string to obtain a value. The string must contain a number, followed by optional whitespace, followed by the unit. The unit must not contain any spaces.

apply

public static DimensionedValue apply(java.math.BigDecimal number,
                     java.lang.String unit)

getDisplayedNumber

public java.math.BigDecimal getDisplayedNumber()

getDisplayedMultiplier

public java.lang.String getDisplayedMultiplier()

parse

public static DimensionedValue parse(java.lang.String value)

Parses a string to obtain a value. The string must contain a number, followed by optional whitespace, followed by the unit. The unit must not contain any spaces.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(DimensionedValue o)

Specified by:

compareTo in interface java.lang.Comparable<DimensionedValue>