org.unitConverter.unit

Class UnitPrefix

java.lang.Object

org.unitConverter.unit.UnitPrefix

public final class UnitPrefix
extends java.lang.Object

A prefix that can be applied to a LinearUnit to multiply it by some value

Since:

2019-10-16

Author:

Adrien Hopkins

Method Summary

Modifier and Type	Method and Description
UnitPrefix	dividedBy(double divisor) Divides this prefix by a scalar
UnitPrefix	dividedBy(UnitPrefix other) Divides this prefix by other.
boolean	equals(java.lang.Object obj) Uses the prefix's multiplier to determine equality.
double	getMultiplier()
java.util.Set<java.lang.String>	getOtherNames()
java.util.Optional<java.lang.String>	getPrimaryName()
java.util.Optional<java.lang.String>	getSymbol()
int	hashCode() Uses the prefix's multiplier to determine a hash code.
UnitPrefix	times(double multiplicand) Multiplies this prefix by a scalar
UnitPrefix	times(UnitPrefix other) Multiplies this prefix by other.
UnitPrefix	toExponent(double exponent) Raises this prefix to an exponent.
java.lang.String	toString()
static UnitPrefix	valueOf(double multiplier) Gets a UnitPrefix from a multiplier
static UnitPrefix	valueOf(double multiplier, NameSymbol ns) Gets a UnitPrefix from a multiplier and a name
UnitPrefix	withName(NameSymbol ns)

Methods inherited from class java.lang.Object

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

Method Detail

valueOf

public static UnitPrefix valueOf(double multiplier)

Gets a UnitPrefix from a multiplier

Parameters:

multiplier - multiplier of prefix

Returns:

prefix

Since:

2019-10-16

valueOf

public static UnitPrefix valueOf(double multiplier,
                                 NameSymbol ns)

Gets a UnitPrefix from a multiplier and a name

Parameters:

multiplier - multiplier of prefix

ns - name(s) and symbol of prefix

Returns:

prefix

Throws:

java.lang.NullPointerException - if ns is null

Since:

2019-10-16

dividedBy

public UnitPrefix dividedBy(double divisor)

Divides this prefix by a scalar

Parameters:

divisor - number to divide by

Returns:

quotient of prefix and scalar

Since:

2019-10-16

dividedBy

public UnitPrefix dividedBy(UnitPrefix other)

Divides this prefix by other.

Parameters:

other - prefix to divide by

Returns:

quotient of prefixes

Since:

2019-04-13, v0.2.0

equals

public boolean equals(java.lang.Object obj)

Uses the prefix's multiplier to determine equality.

Overrides:

equals in class java.lang.Object

getMultiplier

public double getMultiplier()

Returns:

prefix's multiplier

Since:

2019-11-26

getOtherNames

public final java.util.Set<java.lang.String> getOtherNames()

Returns:

other names

Since:

2019-11-26

getPrimaryName

public final java.util.Optional<java.lang.String> getPrimaryName()

Returns:

primary name

Since:

2019-11-26

getSymbol

public final java.util.Optional<java.lang.String> getSymbol()

Returns:

symbol

Since:

2019-11-26

hashCode

public int hashCode()

Uses the prefix's multiplier to determine a hash code.

Overrides:

hashCode in class java.lang.Object

times

public UnitPrefix times(double multiplicand)

Multiplies this prefix by a scalar

Parameters:

multiplicand - number to multiply by

Returns:

product of prefix and scalar

Since:

2019-10-16

times

public UnitPrefix times(UnitPrefix other)

Multiplies this prefix by other.

Parameters:

other - prefix to multiply by

Returns:

product of prefixes

Since:

2019-04-13, v0.2.0

toExponent

public UnitPrefix toExponent(double exponent)

Raises this prefix to an exponent.

Parameters:

exponent - exponent to raise to

Returns:

result of exponentiation.

Since:

2019-04-13, v0.2.0

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

a string describing the prefix and its multiplier

withName

public UnitPrefix withName(NameSymbol ns)

Parameters:

ns - name(s) and symbol to use

Returns:

copy of this prefix with provided name(s) and symbol

Throws:

java.lang.NullPointerException - if ns is null

Since:

2019-11-26