Package com.irurueta.units

Class Frequency

java.lang.Object

com.irurueta.units.Measurement<FrequencyUnit>

com.irurueta.units.Frequency

All Implemented Interfaces:

Serializable

public class Frequency
extends Measurement<FrequencyUnit>

Contains a frequency value and unit.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Frequency()	Constructor.
Frequency(Number value, FrequencyUnit unit)	Constructor with value and unit.

Method Summary

Modifier and Type	Method	Description
void	add(double value, FrequencyUnit unit)	Adds provided frequency value and unit and updates current frequency instance.
static double	add(double value1, FrequencyUnit unit1, double value2, FrequencyUnit unit2, FrequencyUnit resultUnit)	Adds two frequency values and units and returns the result.
void	add(Frequency frequency)	Adds provided frequency and updates current frequency instance.
void	add(Frequency f, Frequency result)	Adds provided frequency and stores the result into provided frequency instance.
static void	add(Frequency arg1, Frequency arg2, Frequency result)	Adds two frequency instances and stores the result into provided instance.
void	add(Number value, FrequencyUnit unit)	Adds provided frequency value and unit and updates current frequency instance.
static Number	add(Number value1, FrequencyUnit unit1, Number value2, FrequencyUnit unit2, FrequencyUnit resultUnit)	Adds two frequency values and units and returns the result.
Frequency	addAndReturnNew(double value, FrequencyUnit unit, FrequencyUnit resultUnit)	Adds provided frequency value and unit and returns a new frequency instance using provided unit.
static Frequency	addAndReturnNew(Frequency arg1, Frequency arg2, FrequencyUnit unit)	Adds two frequency instances.
Frequency	addAndReturnNew(Frequency f, FrequencyUnit unit)	Adds provided frequency to current instance and returns a new frequency instance.
Frequency	addAndReturnNew(Number value, FrequencyUnit unit, FrequencyUnit resultUnit)	Adds provided frequency value and unit and returns a new frequency instance using provided unit.
boolean	equals(Measurement<FrequencyUnit> other, double tolerance)	Determines if two frequencies are equal up to a certain tolerance.
void	subtract(double value, FrequencyUnit unit)	Subtracts provided frequency value and unit and updates current frequency instance.
static double	subtract(double value1, FrequencyUnit unit1, double value2, FrequencyUnit unit2, FrequencyUnit resultUnit)	Subtracts two frequency values and units and returns the result.
void	subtract(Frequency frequency)	Subtracts provided frequency and updates current frequency.
void	subtract(Frequency f, Frequency result)	Subtracts provided frequency and stores the result into provided frequency.
static void	subtract(Frequency arg1, Frequency arg2, Frequency result)	Subtracts two frequency instances and stores the result into provided instance.
void	subtract(Number value, FrequencyUnit unit)	Subtracts provided frequency value and unit and updates current frequency instance.
static Number	subtract(Number value1, FrequencyUnit unit1, Number value2, FrequencyUnit unit2, FrequencyUnit resultUnit)	Subtracts two frequency values and units and returns the result.
Frequency	subtractAndReturnNew(double value, FrequencyUnit unit, FrequencyUnit resultUnit)	Subtracts provided frequency value and unit and returns a new frequency instance using provided unit.
static Frequency	subtractAndReturnNew(Frequency arg1, Frequency arg2, FrequencyUnit unit)	Subtracts two frequency instances.
Frequency	subtractAndReturnNew(Frequency f, FrequencyUnit unit)	Subtracts provided frequency from current instance and returns a new instance.
Frequency	subtractAndReturnNew(Number value, FrequencyUnit unit, FrequencyUnit resultUnit)	Subtracts provided frequency value and unit and returns a new frequency 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

Frequency

public Frequency(Number value,
 FrequencyUnit unit)

Constructor with value and unit.

Parameters:

value - frequency value.

unit - unit of frequency.

Throws:

IllegalArgumentException - if either value or unit is null.

Frequency

Frequency()

Constructor.

Method Details

equals

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

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

Overrides:

equals in class Measurement<FrequencyUnit>

Parameters:

other - another measurement to compare.

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

Returns:

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

add

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

Adds two frequency 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,
 FrequencyUnit unit1,
 Number value2,
 FrequencyUnit unit2,
 FrequencyUnit resultUnit)

Adds two frequency 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(Frequency arg1,
 Frequency arg2,
 Frequency result)

Adds two frequency instances and stores the result into provided instance.

Parameters:

arg1 - 1st argument.

arg2 - 2nd argument.

result - instance where result will be stored.

addAndReturnNew

public static Frequency addAndReturnNew(Frequency arg1,
 Frequency arg2,
 FrequencyUnit unit)

Adds two frequency instances.

Parameters:

arg1 - 1st argument.

arg2 - 2nd argument.

unit - unit of returned frequency.

Returns:

a new instance containing result.

addAndReturnNew

public Frequency addAndReturnNew(double value,
 FrequencyUnit unit,
 FrequencyUnit resultUnit)

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

Parameters:

value - value to be added.

unit - unit of value to be added.

resultUnit - unit of returned frequency.

Returns:

a new frequency containing result.

addAndReturnNew

public Frequency addAndReturnNew(Number value,
 FrequencyUnit unit,
 FrequencyUnit resultUnit)

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

Parameters:

value - value to be added.

unit - unit of value to be added.

resultUnit - unit of returned frequency.

Returns:

a new frequency containing result.

addAndReturnNew

public Frequency addAndReturnNew(Frequency f,
 FrequencyUnit unit)

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

Parameters:

f - frequency to be added.

unit - unit of returned frequency.

Returns:

a new frequency containing result.

add

public void add(double value,
 FrequencyUnit unit)

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

Parameters:

value - frequency value to be added.

unit - unit of frequency value.

add

public void add(Number value,
 FrequencyUnit unit)

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

Parameters:

value - frequency value to be added.

unit - unit of frequency value.

add

public void add(Frequency frequency)

Adds provided frequency and updates current frequency instance.

Parameters:

frequency - frequency to be added.

add

public void add(Frequency f,
 Frequency result)

Adds provided frequency and stores the result into provided frequency instance.

Parameters:

f - frequency to be added.

result - instance where result will be stored.

subtract

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

Subtracts two frequency 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,
 FrequencyUnit unit1,
 Number value2,
 FrequencyUnit unit2,
 FrequencyUnit resultUnit)

Subtracts two frequency 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(Frequency arg1,
 Frequency arg2,
 Frequency result)

Subtracts two frequency instances and stores the result into provided instance.

Parameters:

arg1 - 1st argument.

arg2 - 2nd argument.

result - instance where result will be stored.

subtractAndReturnNew

public static Frequency subtractAndReturnNew(Frequency arg1,
 Frequency arg2,
 FrequencyUnit unit)

Subtracts two frequency instances.

Parameters:

arg1 - 1st argument.

arg2 - 2nd argument.

unit - unit of returned frequency.

Returns:

a new instance containing result.

subtractAndReturnNew

public Frequency subtractAndReturnNew(double value,
 FrequencyUnit unit,
 FrequencyUnit resultUnit)

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

Parameters:

value - value to be subtracted.

unit - unit of value to be subtracted.

resultUnit - unit of returned frequency.

Returns:

a new frequency containing result.

subtractAndReturnNew

public Frequency subtractAndReturnNew(Number value,
 FrequencyUnit unit,
 FrequencyUnit resultUnit)

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

Parameters:

value - value to be subtracted.

unit - unit of value to be subtracted.

resultUnit - unit of returned frequency.

Returns:

a new frequency containing result.

subtractAndReturnNew

public Frequency subtractAndReturnNew(Frequency f,
 FrequencyUnit unit)

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

Parameters:

f - frequency to be subtracted.

unit - unit of returned frequency.

Returns:

a new frequency containing result.

subtract

public void subtract(double value,
 FrequencyUnit unit)

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

Parameters:

value - frequency value to be subtracted.

unit - unit of frequency value.

subtract

public void subtract(Number value,
 FrequencyUnit unit)

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

Parameters:

value - frequency value to be subtracted.

unit - unit of frequency value.

subtract

public void subtract(Frequency frequency)

Subtracts provided frequency and updates current frequency.

Parameters:

frequency - frequency to be subtracted.

subtract

public void subtract(Frequency f,
 Frequency result)

Subtracts provided frequency and stores the result into provided frequency.

Parameters:

f - frequency to be subtracted.

result - instance where result will be stored.