Package io.guldbrand.unit

Class U

java.lang.Object

io.guldbrand.unit.U

public class U
extends Object

Compound Unit, a unit with one or more quantities.

Class and methods primarily for defining, calculating and converting between units of basic and compounded quantities.

Some additional functionality exists for doing absolute conversion between scales, as well as units such as months and years. Those do however have limited functionality. This code should not be used to implement calendar systems.

Field Summary

Fields

Modifier and Type	Field	Description
static U	BARREL
static U	CC
static U	CM
static U	CUP
static U	DAY
static U	DEGREE
static U	DM
static U	FLOZ
static U	FOOT
static U	G
static U	GALLON
static U	H
static U	INCH
static U	KELVIN
static U	KG
static U	KM
static U	L
static U	LIGHTYEAR
static U	M
static U	MILE
static U	MIN
static U	ML
static U	MM
static U	MONTH
static U	MS
static U	N
static U	NONE
static U	OUNCE
static U	PINT
static U	POUND
static U	RADIAN
static U	S
static U	SC
static U	SCM
static U	TABLESPOON
static U	TEASPOON
static U	TON
static U	TON_UK
static U	TON_US
static U	WEEK
static U	YARD
static U	YEAR

Constructor Summary

Constructors

Constructor	Description
U(U u, double compoundLength, String shortName, String longName)	Defines a new Unit based on another.
U(String shortName, String longName, Quantity quantity)	Creates a new Unit from scratch.

Method Summary

Modifier and Type	Method	Description
U	dimDiff(U b)	Calculates and the Unit that is the dimensional difference between this Unit and another.
static U	dimDiff(U a, U b)	Calculates and the Unit that is the dimensional difference between Unit A and Unit B.
U	div(U a)	Divide this unit with another unit.
boolean	equals(Object obj)
static U	getBestUnit(UV uv, double target)	Calculates and returns the most suitable unit to display a given UV in.
String	getDerivedName()	Returns the derived name for this unit.
U	inverse()	Calculate the inverse of this unit.
boolean	isSameQuantity(U b)	Checks whether or not this unit and unit b has the same total quantity.
U	mul(U a)	Multiply this Unit with another Unit.
U	pow(double p)	Perform repeated multiplication of this unit with itself.
U	reduce()	Checks the unit for multiple instances of the same quantity and combines them.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final U NONE

M

public static final U M

MM

public static final U MM

CM

public static final U CM

DM

public static final U DM

KM

public static final U KM

INCH

public static final U INCH

FOOT

public static final U FOOT

YARD

public static final U YARD

MILE

public static final U MILE

LIGHTYEAR

public static final U LIGHTYEAR

L

public static final U L

ML

public static final U ML

TEASPOON

public static final U TEASPOON

TABLESPOON

public static final U TABLESPOON

FLOZ

public static final U FLOZ

CUP

public static final U CUP

PINT

public static final U PINT

GALLON

public static final U GALLON

BARREL

public static final U BARREL

G

public static final U G

KG

public static final U KG

TON

public static final U TON

OUNCE

public static final U OUNCE

POUND

public static final U POUND

TON_UK

public static final U TON_UK

TON_US

public static final U TON_US

S

public static final U S

MS

public static final U MS

MIN

public static final U MIN

H

public static final U H

DAY

public static final U DAY

WEEK

public static final U WEEK

YEAR

public static final U YEAR

MONTH

public static final U MONTH

RADIAN

public static final U RADIAN

DEGREE

public static final U DEGREE

KELVIN

public static final U KELVIN

N

public static final U N

CC

public static final U CC

SC

public static final U SC

SCM

public static final U SCM

Constructor Detail

U

public U(String shortName,
         String longName,
         Quantity quantity)

Creates a new Unit from scratch. If there already exists a Unit that you want to base a new one on, use U(U, double, String, String) instead.}

Parameters:

shortName - the short name or abbreviation for this unit. For the SI-unit meter this would be "m".

longName - the long name for this unit. For the SI-unit meter this would be "meter".

quantity - the quantity that this unit will represent.

U

public U(U u,
         double compoundLength,
         String shortName,
         String longName)

Defines a new Unit based on another. The new unit will have the same Quantity as the old one but can be given a different length and name.

Parameters:

u - the Unit this unit will have the same quantity as.

compoundLength - the length of this unit compared to the other Unit. For the SI-unit millimeter this would be 0.001 if the other Unit was meter.

shortName - the short name or abbreviation for this unit. For the SI-unit meter this would be "m".

longName - the long name for this unit. For the SI-unit meter this would be "meter".

Method Detail

mul

public U mul(U a)

Multiply this Unit with another Unit.

Parameters:

a - the Unit to multiply with.

Returns:

The resulting Unit.

div

public U div(U a)

Divide this unit with another unit.

Parameters:

a - the unit to divide with.

Returns:

The resulting (compound) unit.

pow

public U pow(double p)

Perform repeated multiplication of this unit with itself.

Parameters:

p - The exponent. 0: result is NONE. 1: Result is itself. >1: Power. <0: Result is inverted and given power.

Returns:

The resulting unit.

inverse

public U inverse()

Calculate the inverse of this unit. This is equivalent to pow(-1).

Returns:

The resulting inverted unit.

reduce

public U reduce()

Checks the unit for multiple instances of the same quantity and combines them. This will for instance convert ( m^2 / m ) to ( m ).

Returns:

the reduced compound unit.

dimDiff

public U dimDiff(U b)

Calculates and the Unit that is the dimensional difference between this Unit and another. That will be the unit you should multiply this unit with to get the target unit. Ex: meter.dimDiff( kg ) will return the unit ( kg / m ).

Parameters:

b - the target Unit.

Returns:

a Unit representing the dimensional difference between this and target unit.

dimDiff

public static U dimDiff(U a,
                        U b)

Calculates and the Unit that is the dimensional difference between Unit A and Unit B. That will be the unit you should multiply A with to get B. Ex: dimDiff( meter, kg ) will return the unit ( kg / m ).

Parameters:

a - the unit that can be multiplied with returned value to get B.

b - the other unit.

Returns:

a Unit representing the dimensional difference between this and target unit.

isSameQuantity

public boolean isSameQuantity(U b)

Checks whether or not this unit and unit b has the same total quantity. (Basically if they could be added.)

Parameters:

b - the unit to check against.

Returns:

True iff the units have the same quantity.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getBestUnit

public static U getBestUnit(UV uv,
                            double target)

Calculates and returns the most suitable unit to display a given UV in.

Parameters:

uv - the source unit vector you want the best unit for

target - the target value of the numeric part.

Returns:

the most suitable unit to display UV in.

getDerivedName

public String getDerivedName()

Returns the derived name for this unit.

Returns:

the derived name of this unit.

toString

public String toString()

Overrides:

toString in class Object