EmptyQuantity (PowerSystemUtils 1.6 API)

java.lang.Object
- tech.units.indriya.AbstractQuantity<Q>
- - edu.ie3.util.quantities.EmptyQuantity<Q>

Type Parameters:

Q - Unit of this quantity

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<javax.measure.Quantity<Q>>, javax.measure.Quantity<Q>, tech.units.indriya.ComparableQuantity<Q>, tech.uom.lib.common.function.QuantityConverter<Q>, tech.uom.lib.common.function.UnitSupplier<Q>, tech.uom.lib.common.function.ValueSupplier<java.lang.Number>
```
public final class EmptyQuantity<Q extends javax.measure.Quantity<Q>>
extends tech.units.indriya.AbstractQuantity<Q>
```
This class represents a Quantity with the value null. So i.e. instead of "Quantity<Length> length = null;" you should use "Quantity<Length> length = EmptyQuantity.of(Units.METRE);"
Any arithmetic operations you perform on this class will throw a EmptyQuantityException as you're not intended to do so. The reason to have this quantity instead of using null directly is to provide a more obvious way to deal with empty quantities instead of just using null for an empty quantity.
Possible application cases are e.g. time series consisting of several quantities based on real data. As real time series sometimes might lack some values, it is preferred to indicate that that these values are missing in the input data by providing an instance of EmptyQuantity instead of using null. This is motivated by making the missing value explicit, instead of implicitly assuming that null represents a missing value.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface javax.measure.Quantity
  javax.measure.Quantity.Scale

Field Summary
- Fields inherited from class tech.units.indriya.AbstractQuantity
  NONE, ONE

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`tech.units.indriya.ComparableQuantity<Q>`	`add(javax.measure.Quantity<Q> that)` Deprecated. EmptyQuantity represents a 'null' value, so you should not perform any operations on this Quantity
`tech.units.indriya.ComparableQuantity<Q>`	`divide(java.lang.Number that)` Deprecated. EmptyQuantity represents a 'null' value, so you should not perform any operations on this Quantity
`tech.units.indriya.ComparableQuantity<?>`	`divide(javax.measure.Quantity<?> that)` Deprecated. EmptyQuantity represents a 'null' value, so you should not perform any operations on this Quantity
`boolean`	`equals(java.lang.Object that)` Decides equality based only on the type of the object: If it is an EmptyQuantity, it is equal.
`java.lang.Number`	`getValue()` Returns always null, as that is the only value an EmptyQuantity can and should have
`int`	`hashCode()` Deprecated. EmptyQuantity represents a 'null' value, so you should not perform any operations on this Quantity
`tech.units.indriya.ComparableQuantity<?>`	`inverse()` Deprecated. EmptyQuantity represents a 'null' value, so you should not perform any operations on this Quantity
`boolean`	`isEquivalentTo(javax.measure.Quantity that)` Decides equality based only on the type of the quantity: If it is an EmptyQuantity, it is equal.
`tech.units.indriya.ComparableQuantity<Q>`	`multiply(java.lang.Number multiplier)` Deprecated. EmptyQuantity represents a 'null' value, so you should not perform any operations on this Quantity
`tech.units.indriya.ComparableQuantity<?>`	`multiply(javax.measure.Quantity<?> multiplier)` Deprecated. EmptyQuantity represents a 'null' value, so you should not perform any operations on this Quantity
`javax.measure.Quantity<Q>`	`negate()` Deprecated. EmptyQuantity represents a 'null' value, so you should not perform any operations on this Quantity
`static <U extends javax.measure.Quantity<U>> EmptyQuantity<U>`	`of(javax.measure.Unit<U> unit)` Initializes an EmptyQuantity with the specified Unit
`tech.units.indriya.ComparableQuantity<Q>`	`subtract(javax.measure.Quantity<Q> that)` Deprecated. EmptyQuantity represents a 'null' value, so you should not perform any operations on this Quantity

Methods inherited from class tech.units.indriya.AbstractQuantity
asType, compareTo, divide, getScale, getUnit, hasFraction, hasFraction, inverse, isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo, multiply, numberSystem, parse, to, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.measure.Quantity
toSystemUnit

- Method Detail
  - of
```
public static <U extends javax.measure.Quantity<U>> EmptyQuantity<U> of(javax.measure.Unit<U> unit)
```
    Initializes an EmptyQuantity with the specified Unit
    
    Type Parameters:
    
    U - The Unit/Quantity type of the EmptyQuantity object
    
    Parameters:
    
    unit - The Unit for the EmptyQuantity
    
    Returns:
    
    EmptyQuantity with specified unit
  - getValue
```
public java.lang.Number getValue()
```
    Returns always null, as that is the only value an EmptyQuantity can and should have
    
    Specified by:
    
    getValue in interface javax.measure.Quantity<Q extends javax.measure.Quantity<Q>>
    
    Specified by:
    
    getValue in interface tech.uom.lib.common.function.ValueSupplier<java.lang.Number>
    
    Overrides:
    
    getValue in class tech.units.indriya.AbstractQuantity<Q extends javax.measure.Quantity<Q>>
    
    Returns:
    
    null, always
  - add
```
@Deprecated
public tech.units.indriya.ComparableQuantity<Q> add(javax.measure.Quantity<Q> that)
```
    Deprecated. EmptyQuantity represents a 'null' value, so you should not perform any operations on this Quantity
    
    Overrides the super method, only to throw a EmptyQuantityException in any case as you should not perform operations on this Quantity
    
    Parameters:
    
    that - Quantity to perform the operation on
    
    Returns:
    
    nothing, ever. Throws EmptyQuantityException instead.
  - subtract
```
@Deprecated
public tech.units.indriya.ComparableQuantity<Q> subtract(javax.measure.Quantity<Q> that)
```
    Deprecated. EmptyQuantity represents a 'null' value, so you should not perform any operations on this Quantity
    
    Overrides the super method, only to throw a EmptyQuantityException in any case as you should not perform operations on this Quantity
    
    Parameters:
    
    that - Quantity to perform the operation on
    
    Returns:
    
    nothing, ever. Throws EmptyQuantityException instead.
  - divide
```
@Deprecated
public tech.units.indriya.ComparableQuantity<?> divide(javax.measure.Quantity<?> that)
```
    Deprecated. EmptyQuantity represents a 'null' value, so you should not perform any operations on this Quantity
    
    Overrides the super method, only to throw a EmptyQuantityException in any case as you should not perform operations on this Quantity
    
    Parameters:
    
    that - Quantity to perform the operation on
    
    Returns:
    
    nothing, ever. Throws EmptyQuantityException instead.
  - divide
```
@Deprecated
public tech.units.indriya.ComparableQuantity<Q> divide(java.lang.Number that)
```
    Deprecated. EmptyQuantity represents a 'null' value, so you should not perform any operations on this Quantity
    
    Overrides the super method, only to throw a EmptyQuantityException in any case as you should not perform operations on this Quantity
    
    Parameters:
    
    that - Quantity to perform the operation on
    
    Returns:
    
    nothing, ever. Throws EmptyQuantityException instead.
  - multiply
```
@Deprecated
public tech.units.indriya.ComparableQuantity<?> multiply(javax.measure.Quantity<?> multiplier)
```
    Deprecated. EmptyQuantity represents a 'null' value, so you should not perform any operations on this Quantity
    
    Overrides the super method, only to throw a EmptyQuantityException in any case as you should not perform operations on this Quantity
    
    Parameters:
    
    multiplier - Quantity to perform the operation on
    
    Returns:
    
    nothing, ever. Throws EmptyQuantityException instead.
  - multiply
```
@Deprecated
public tech.units.indriya.ComparableQuantity<Q> multiply(java.lang.Number multiplier)
```
    Deprecated. EmptyQuantity represents a 'null' value, so you should not perform any operations on this Quantity
    
    Overrides the super method, only to throw a EmptyQuantityException in any case as you should not perform operations on this Quantity
    
    Parameters:
    
    multiplier - Quantity to perform the operation on
    
    Returns:
    
    nothing, ever. Throws EmptyQuantityException instead.
  - inverse
```
@Deprecated
public tech.units.indriya.ComparableQuantity<?> inverse()
```
    Deprecated. EmptyQuantity represents a 'null' value, so you should not perform any operations on this Quantity
    
    Overrides the super method, only to throw a EmptyQuantityException in any case as you should not perform operations on this Quantity
    
    Returns:
    
    nothing, ever. Throws EmptyQuantityException instead.
  - negate
```
@Deprecated
public javax.measure.Quantity<Q> negate()
```
    Deprecated. EmptyQuantity represents a 'null' value, so you should not perform any operations on this Quantity
    
    Overrides the super method, only to throw a EmptyQuantityException in any case as you should not perform operations on this Quantity
    
    Returns:
    
    nothing, ever. Throws EmptyQuantityException instead.
  - equals
```
public boolean equals(java.lang.Object that)
```
    Decides equality based only on the type of the object: If it is an EmptyQuantity, it is equal. This is based on the thought that nothing is always equals to nothing.
    
    Overrides:
    
    equals in class tech.units.indriya.AbstractQuantity<Q extends javax.measure.Quantity<Q>>
    
    Parameters:
    
    that - object to compare
    
    Returns:
    
    true, if the object is an EmptyQuantity
  - hashCode
```
@Deprecated
public int hashCode()
```
    Deprecated. EmptyQuantity represents a 'null' value, so you should not perform any operations on this Quantity
    
    Overrides the super method, only to throw a EmptyQuantityException in any case as you can't create a hashcode representing null.
    
    Overrides:
    
    hashCode in class tech.units.indriya.AbstractQuantity<Q extends javax.measure.Quantity<Q>>
    
    Returns:
    
    nothing, ever. Throws EmptyQuantityException instead.
  - isEquivalentTo
```
public boolean isEquivalentTo(javax.measure.Quantity that)
```
    Decides equality based only on the type of the quantity: If it is an EmptyQuantity, it is equal. An EmptyQuantity does not have a value, so equality is checked using the equals(Object) method.
    
    Specified by:
    
    isEquivalentTo in interface javax.measure.Quantity<Q extends javax.measure.Quantity<Q>>
    
    Overrides:
    
    isEquivalentTo in class tech.units.indriya.AbstractQuantity<Q extends javax.measure.Quantity<Q>>
    
    Parameters:
    
    that - object to compare
    
    Returns:
    
    true, if the object is an EmptyQuantity

Class EmptyQuantity<Q extends javax.measure.Quantity<Q>>

Nested Class Summary

Nested classes/interfaces inherited from interface javax.measure.Quantity

Field Summary

Fields inherited from class tech.units.indriya.AbstractQuantity

Method Summary

Methods inherited from class tech.units.indriya.AbstractQuantity

Methods inherited from class java.lang.Object

Methods inherited from interface javax.measure.Quantity

Method Detail

of

getValue

add

subtract

divide

divide

multiply

multiply

inverse

negate

equals

hashCode

isEquivalentTo