Package com.irurueta.units

Class Distance

java.lang.Object

com.irurueta.units.Measurement<DistanceUnit>

com.irurueta.units.Distance

All Implemented Interfaces:

Serializable

public class Distance
extends Measurement<DistanceUnit>

Contains a distance value and unit.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Distance()	Constructor.
Distance(Number value, DistanceUnit unit)	Constructor with value and unit.

Method Summary

Modifier and Type	Method	Description
void	add(double value, DistanceUnit unit)	Adds provided distance value and unit and updates current distance instance.
static double	add(double value1, DistanceUnit unit1, double value2, DistanceUnit unit2, DistanceUnit resultUnit)	Adds two distance values and units and returns the result.
void	add(Distance distance)	Adds provided distance and updates current distance.
void	add(Distance d, Distance result)	Adds provided distance and stores the result into provided distance.
static void	add(Distance arg1, Distance arg2, Distance result)	Adds two distances and stores the result into provided instance.
void	add(Number value, DistanceUnit unit)	Adds provided distance value and unit and updates current distance instance.
static Number	add(Number value1, DistanceUnit unit1, Number value2, DistanceUnit unit2, DistanceUnit resultUnit)	Adds two distance values and units and returns the result.
Distance	addAndReturnNew(double value, DistanceUnit unit, DistanceUnit resultUnit)	Adds provided distance value and unit and returns a new distance instance using provided unit.
static Distance	addAndReturnNew(Distance arg1, Distance arg2, DistanceUnit unit)	Adds two distances.
Distance	addAndReturnNew(Distance d, DistanceUnit unit)	Adds provided distance to current instance and returns a new distance.
Distance	addAndReturnNew(Number value, DistanceUnit unit, DistanceUnit resultUnit)	Adds provided distance value and unit and returns a new distance instance using provided unit.
boolean	equals(Measurement<DistanceUnit> other, double tolerance)	Determines if two distances are equal up to a certain tolerance.
void	subtract(double value, DistanceUnit unit)	Subtracts provided distance value and unit and updates current distance instance.
static double	subtract(double value1, DistanceUnit unit1, double value2, DistanceUnit unit2, DistanceUnit resultUnit)	Subtracts two distance values and units and returns the result.
void	subtract(Distance distance)	Subtracts provided distance and updates current distance.
void	subtract(Distance d, Distance result)	Subtracts provided distance and stores the result into provided distance.
static void	subtract(Distance arg1, Distance arg2, Distance result)	Subtracts two distances and stores the result into provided instance.
void	subtract(Number value, DistanceUnit unit)	Subtracts provided distance value and unit and updates current distance instance.
static Number	subtract(Number value1, DistanceUnit unit1, Number value2, DistanceUnit unit2, DistanceUnit resultUnit)	Subtracts two distance values and units and returns the result.
Distance	subtractAndReturnNew(double value, DistanceUnit unit, DistanceUnit resultUnit)	Subtracts provided distance value and unit and returns a new distance instance using provided unit.
static Distance	subtractAndReturnNew(Distance arg1, Distance arg2, DistanceUnit unit)	Subtracts two distances.
Distance	subtractAndReturnNew(Distance d, DistanceUnit unit)	Subtracts provided distance from current instance and returns a new distance.
Distance	subtractAndReturnNew(Number value, DistanceUnit unit, DistanceUnit resultUnit)	Subtracts provided distance value and unit and returns a new distance instance using provided unit.

Methods inherited from class com.irurueta.units.Measurement

equals, getUnit, getValue, hashCode, setUnit, setValue

Methods inherited from class java.lang.Object

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

Constructor Details

Distance

public Distance(Number value,
 DistanceUnit unit)

Constructor with value and unit.

Parameters:

value - distance value.

unit - unit of distance.

Throws:

IllegalArgumentException - if either value or unit is null.

Distance

Distance()

Constructor.

Method Details

equals

public boolean equals(Measurement<DistanceUnit> other,
 double tolerance)

Determines if two distances are equal up to a certain tolerance. If needed, this method attempts unit conversion to compare both objects.

Overrides:

equals in class Measurement<DistanceUnit>

Parameters:

other - another distance to compare.

tolerance - amount of tolerance to determine whether two distance instances are equal or not.

Returns:

true if provided distance is assumed to be equal to this instance, false otherwise.

add

public static double add(double value1,
 DistanceUnit unit1,
 double value2,
 DistanceUnit unit2,
 DistanceUnit resultUnit)

Adds two distance values and units and returns the result.

Parameters:

value1 - 1st argument value.

unit1 - 1st argument unit.

value2 - 2nd argument value.

unit2 - 2nd argument unit.

resultUnit - unit of result to be returned.

Returns:

result of addition.

add

public static Number add(Number value1,
 DistanceUnit unit1,
 Number value2,
 DistanceUnit unit2,
 DistanceUnit resultUnit)

Adds two distance values and units and returns the result.

Parameters:

value1 - 1st argument value.

unit1 - 1st argument unit.

value2 - 2nd argument value.

unit2 - 2nd argument unit.

resultUnit - unit of result to be returned.

Returns:

result of addition.

add

public static void add(Distance arg1,
 Distance arg2,
 Distance result)

Adds two distances and stores the result into provided instance.

Parameters:

arg1 - 1st argument.

arg2 - 2nd argument.

result - instance where result will be stored.

addAndReturnNew

public static Distance addAndReturnNew(Distance arg1,
 Distance arg2,
 DistanceUnit unit)

Adds two distances.

Parameters:

arg1 - 1st argument.

arg2 - 2nd argument.

unit - unit of returned distance.

Returns:

a new instance containing result.

addAndReturnNew

public Distance addAndReturnNew(double value,
 DistanceUnit unit,
 DistanceUnit resultUnit)

Adds provided distance value and unit and returns a new distance instance using provided unit.

Parameters:

value - value to be added.

unit - unit of value to be added.

resultUnit - unit of returned distance.

Returns:

a new distance containing result.

addAndReturnNew

public Distance addAndReturnNew(Number value,
 DistanceUnit unit,
 DistanceUnit resultUnit)

Adds provided distance value and unit and returns a new distance instance using provided unit.

Parameters:

value - value to be added.

unit - unit of value to be added.

resultUnit - unit of returned distance.

Returns:

a new distance containing result.

addAndReturnNew

public Distance addAndReturnNew(Distance d,
 DistanceUnit unit)

Adds provided distance to current instance and returns a new distance.

Parameters:

d - distance to be added.

unit - unit of returned distance.

Returns:

a new distance containing result.

add

public void add(double value,
 DistanceUnit unit)

Adds provided distance value and unit and updates current distance instance.

Parameters:

value - distance value to be added.

unit - unit of distance value.

add

public void add(Number value,
 DistanceUnit unit)

Adds provided distance value and unit and updates current distance instance.

Parameters:

value - distance value to be added.

unit - unit of distance value.

add

public void add(Distance distance)

Adds provided distance and updates current distance.

Parameters:

distance - distance to be added.

add

public void add(Distance d,
 Distance result)

Adds provided distance and stores the result into provided distance.

Parameters:

d - distance to be added.

result - instance where result will be stored.

subtract

public static double subtract(double value1,
 DistanceUnit unit1,
 double value2,
 DistanceUnit unit2,
 DistanceUnit resultUnit)

Subtracts two distance values and units and returns the result.

Parameters:

value1 - 1st argument value.

unit1 - 1st argument unit.

value2 - 2nd argument value.

unit2 - 2nd argument unit.

resultUnit - unit of result to be returned.

Returns:

result of subtraction.

subtract

public static Number subtract(Number value1,
 DistanceUnit unit1,
 Number value2,
 DistanceUnit unit2,
 DistanceUnit resultUnit)

Subtracts two distance values and units and returns the result.

Parameters:

value1 - 1st argument value.

unit1 - 1st argument unit.

value2 - 2nd argument value.

unit2 - 2nd argument unit.

resultUnit - unit of result to be returned.

Returns:

result of subtraction.

subtract

public static void subtract(Distance arg1,
 Distance arg2,
 Distance result)

Subtracts two distances and stores the result into provided instance.

Parameters:

arg1 - 1st argument.

arg2 - 2nd argument.

result - instance where result will be stored.

subtractAndReturnNew

public static Distance subtractAndReturnNew(Distance arg1,
 Distance arg2,
 DistanceUnit unit)

Subtracts two distances.

Parameters:

arg1 - 1st argument.

arg2 - 2nd argument.

unit - unit of returned distance.

Returns:

a new instance containing result.

subtractAndReturnNew

public Distance subtractAndReturnNew(double value,
 DistanceUnit unit,
 DistanceUnit resultUnit)

Subtracts provided distance value and unit and returns a new distance instance using provided unit.

Parameters:

value - value to be subtracted.

unit - unit of value to be subtracted.

resultUnit - unit of returned distance.

Returns:

a new distance containing result.

subtractAndReturnNew

public Distance subtractAndReturnNew(Number value,
 DistanceUnit unit,
 DistanceUnit resultUnit)

Subtracts provided distance value and unit and returns a new distance instance using provided unit.

Parameters:

value - value to be subtracted.

unit - unit of value to be subtracted.

resultUnit - unit of returned distance.

Returns:

a new distance containing result.

subtractAndReturnNew

public Distance subtractAndReturnNew(Distance d,
 DistanceUnit unit)

Subtracts provided distance from current instance and returns a new distance.

Parameters:

d - distance to be subtracted.

unit - unit of returned distance.

Returns:

a new distance containing result.

subtract

public void subtract(double value,
 DistanceUnit unit)

Subtracts provided distance value and unit and updates current distance instance.

Parameters:

value - distance value to be subtracted.

unit - unit of distance value.

subtract

public void subtract(Number value,
 DistanceUnit unit)

Subtracts provided distance value and unit and updates current distance instance.

Parameters:

value - distance value to be subtracted.

unit - unit of distance value.

subtract

public void subtract(Distance distance)

Subtracts provided distance and updates current distance.

Parameters:

distance - distance to be subtracted.

subtract

public void subtract(Distance d,
 Distance result)

Subtracts provided distance and stores the result into provided distance.

Parameters:

d - distance to be subtracted.

result - instance where result will be stored.