Top Description Fields Constructors Methods
io.reactivex.schedulers

public final Class Timed<T>

extends Object
Class Inheritance
Type Parameters
<T>
the value type
Imports
java.util.concurrent.TimeUnit, io.reactivex.annotations.NonNull, io.reactivex.internal.functions.ObjectHelper

Holds onto a value along with time information.

Field Summary

Modifier and TypeField and Description
pack-priv final long
pack-priv final TimeUnit
pack-priv final T

Constructor Summary

AccessConstructor and Description
public
Timed(T
the value to hold
value
,
long
the time to hold
time
,
TimeUnit
the time unit, not null
unit
)

Constructs a Timed instance with the given value and time information.

Method Summary

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

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public long

Returns:

the time value
time
()

Returns the time value.

public long

Returns:

the converted time
time
(TimeUnit
the time unt
unit
)

Returns the contained time value in the time unit specified.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public TimeUnit

Returns:

the time unit of the contained time
unit
()

Returns the time unit of the contained time.

public T

Returns:

the contained value
value
()

Returns the contained value.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

timeback to summary
pack-priv final long time
unitback to summary
pack-priv final TimeUnit unit
valueback to summary
pack-priv final T value

Constructor Detail

Timedback to summary
public Timed(T value, long time, TimeUnit unit)

Constructs a Timed instance with the given value and time information.

Parameters
value:T

the value to hold

time:long

the time to hold

unit:TimeUnit

the time unit, not null

Exceptions
NullPointerException:
if unit is null

Method Detail

equalsback to summary
public boolean equals(Object other)

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
other: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
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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
timeback to summary
public long time()

Returns the time value.

Returns:long

the time value

timeback to summary
public long time(TimeUnit unit)

Returns the contained time value in the time unit specified.

Parameters
unit:TimeUnit

the time unt

Returns:long

the converted time

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
unitback to summary
public TimeUnit unit()

Returns the time unit of the contained time.

Returns:TimeUnit

the time unit of the contained time

Annotations
@NonNull
valueback to summary
public T value()

Returns the contained value.

Returns:T

the contained value

Annotations
@NonNull