Top Description Fields Constructors Methods
tech.units.indriya.quantity.time

public Class TimedData<T>

extends Object
implements Nameable, Supplier<T>
Class Inheritance
All Implemented Interfaces
java.util.function.Supplier, tech.uom.lib.common.function.Nameable
Known Direct Subclasses
tech.units.indriya.quantity.time.TimedQuantityData
Type Parameters
<T>
The data value.
Imports
java.time.Instant, java.util.Objects, java.util.function.Supplier, tech.uom.lib.common.function.Nameable

TimedData is a container for a data value that keeps track of its age. This class keeps track of the birth time of a bit of data, i.e. time the object is instantiated.
The TimedData MUST be immutable.
Author
Werner Keil
Since
1.0
Version
0.7
See Also
Wikipedia: Time Series

Field Summary

Modifier and TypeField and Description
private final Instant
private final String
private final long
private final T

Constructor Summary

AccessConstructor and Description
protected
TimedData(T value, long
The timestamp of the TimedData.
time
)

Construct an instance of TimedData with a value and timestamp.

protected
TimedData(T value, long
The timestamp of the TimedData.
time
,
String
The name of the TimedData.
name
)

Construct an instance of TimedData with a value, a timestamp and a name.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public T
get()

Implements java.util.function.Supplier.get.

Gets a result.

public Instant
public String
public long

Returns:

the time of creation
getTimestamp
()

Returns the time with which this TimedData was created.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public static <
the class of the value
T
>
TimedData<T>

Returns:

an TimedData with the given values
of
(T
The value for the timed data.
val
,
long
The timestamp.
time
)

Returns a TimedData with the specified values.

public static <
the class of the value
T
>
TimedData<T>

Returns:

an TimedData with the given values
of
(T
The value for the timed data.
val
,
long
The timestamp.
time
,
String
The name.
name
)

Returns a TimedData with the specified values.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

instantback to summary
private final Instant instant
nameback to summary
private final String name
timestampback to summary
private final long timestamp
valueback to summary
private final T value

Constructor Detail

TimedDataback to summary
protected TimedData(T value, long time)

Construct an instance of TimedData with a value and timestamp.

Parameters
time:long

The timestamp of the TimedData.

TimedDataback to summary
protected TimedData(T value, long time, String name)

Construct an instance of TimedData with a value, a timestamp and a name.

Parameters
time:long

The timestamp of the TimedData.

name:String

The name of the TimedData.

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getback to summary
public T get()

Implements java.util.function.Supplier.get.

Doc from java.util.function.Supplier.get.

Gets a result.

Returns:T

a result

getInstantback to summary
public Instant getInstant()
getNameback to summary
public String getName()

Implements tech.uom.lib.common.function.Nameable.getName.

Returns:String

Doc from tech.uom.lib.common.function.Nameable.getName.

a name

getTimestampback to summary
public long getTimestamp()

Returns the time with which this TimedData was created.

Returns:long

the time of creation

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
ofback to summary
public static <T> TimedData<T> of(T val, long time)

Returns a TimedData with the specified values.

Parameters
<T>
the class of the value
val:T

The value for the timed data.

time:long

The timestamp.

Returns:TimedData<T>

an TimedData with the given values

ofback to summary
public static <T> TimedData<T> of(T val, long time, String name)

Returns a TimedData with the specified values.

Parameters
<T>
the class of the value
val:T

The value for the timed data.

time:long

The timestamp.

name:String

The name.

Returns:TimedData<T>

an TimedData with the given values

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override