EpochTimeRange

java.lang.Object
- com.idevicesinc.sweetblue.utils.EpochTimeRange

All Implemented Interfaces:

UsesCustomNull
```
public final class EpochTimeRange
extends java.lang.Object
implements UsesCustomNull
```
Class representing a range of time between two instances of EpochTime. This is similar to Interval but stores the actual beginning and end times and is generally meant for longer periods of time.

Field Summary

Fields
Modifier and Type	Field and Description
`static EpochTimeRange`	`FIVE_SECONDS`
`static EpochTimeRange`	`FROM_1970_TO_MAX`
`static EpochTimeRange`	`FROM_MIN_TO_1970`
`static EpochTimeRange`	`FROM_MIN_TO_MAX`
`static EpochTimeRange`	`NULL` Fulfills the soft contract of `UsesCustomNull` - used for `isNull()`.
`static EpochTimeRange`	`ZERO`

Constructor Summary

Constructors
Constructor and Description
`EpochTimeRange(EpochTime from, EpochTime to)` Returns a new instance representing the time range between the given epoch times.
`EpochTimeRange(long from, long to)` Returns a new instance representing the time range between the given epoch times as primitive longs.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static EpochTimeRange`	`denull(EpochTimeRange range_nullable)`
`EpochTime`	`from()` Returns the "from" date passed into the constructor, or `EpochTime.NULL` if `null` was originally passed in.
`static EpochTimeRange`	`from1970_toGiven(EpochTime to)` Returns a new instance representing the time range from 1970 to the given value.
`static EpochTimeRange`	`from1970_toNow()` Returns a new instance representing the time range from 1970 to now.
`static EpochTimeRange`	`fromGiven_toGiven(EpochTime from, EpochTime to)` Basically just a more readable overload for the normal constructor `EpochTimeRange(EpochTime, EpochTime)`.
`static EpochTimeRange`	`fromGiven_toMax(EpochTime from)` Returns a new instance representing the time range from the given value to `Long.MAX_VALUE`.
`static EpochTimeRange`	`fromGiven_toNow(EpochTime from)` Returns a new instance representing the time range from the given value to now.
`static EpochTimeRange`	`fromMin_toGiven(EpochTime to)` Returns a new instance representing the time range from `Long.MIN_VALUE` to the given value.
`long`	`getDelta()` Returns the raw milliseconds between `from()` and `to()`.
`boolean`	`gt(EpochTimeRange otherRange)` "greater than" comparison.
`boolean`	`gte(EpochTimeRange otherRange)` "greater than or equal" comparison.
`static EpochTimeRange`	`instant(EpochTime time)` Returns a new instance representing an instant zero length time range.
`boolean`	`isInvalid()` Returns `true` if `from()` is greater than `to()`.
`boolean`	`isInvalidOrZero()` See `isInvalid()` and `isZero()`.
`boolean`	`isNull()` Returns `true` if `this` is referentially equal to `NULL`.
`boolean`	`isValid()` Returns `true` if `from()` is less than or equal to `to()`.
`boolean`	`isZero()` Returns `true` if `from()` and `to()` are equal.
`boolean`	`lt(EpochTimeRange otherRange)` "less than" comparison.
`boolean`	`lte(EpochTimeRange otherRange)` "less than or equal" comparison.
`EpochTime`	`to()` Returns the "to" date passed into the constructor, or `EpochTime.NULL` if `null` was originally passed in.

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

- Field Detail
  - NULL
```
public static final EpochTimeRange NULL
```
    Fulfills the soft contract of UsesCustomNull - used for isNull().
  - FROM_MIN_TO_1970
```
public static final EpochTimeRange FROM_MIN_TO_1970
```
  - FROM_MIN_TO_MAX
```
public static final EpochTimeRange FROM_MIN_TO_MAX
```
  - FROM_1970_TO_MAX
```
public static final EpochTimeRange FROM_1970_TO_MAX
```
  - ZERO
```
public static final EpochTimeRange ZERO
```
  - FIVE_SECONDS
```
public static final EpochTimeRange FIVE_SECONDS
```
- Constructor Detail
  - EpochTimeRange
```
public EpochTimeRange(EpochTime from,
                      EpochTime to)
```
    Returns a new instance representing the time range between the given epoch times.
  - EpochTimeRange
```
public EpochTimeRange(long from,
                      long to)
```
    Returns a new instance representing the time range between the given epoch times as primitive longs.
- Method Detail
  - fromGiven_toMax
```
public static EpochTimeRange fromGiven_toMax(EpochTime from)
```
    Returns a new instance representing the time range from the given value to Long.MAX_VALUE.
  - fromGiven_toNow
```
public static EpochTimeRange fromGiven_toNow(EpochTime from)
```
    Returns a new instance representing the time range from the given value to now.
  - fromGiven_toGiven
```
public static EpochTimeRange fromGiven_toGiven(EpochTime from,
                                               EpochTime to)
```
    Basically just a more readable overload for the normal constructor EpochTimeRange(EpochTime, EpochTime).
  - from1970_toGiven
```
public static EpochTimeRange from1970_toGiven(EpochTime to)
```
    Returns a new instance representing the time range from 1970 to the given value.
  - fromMin_toGiven
```
public static EpochTimeRange fromMin_toGiven(EpochTime to)
```
    Returns a new instance representing the time range from Long.MIN_VALUE to the given value.
  - from1970_toNow
```
public static EpochTimeRange from1970_toNow()
```
    Returns a new instance representing the time range from 1970 to now.
  - instant
```
public static EpochTimeRange instant(EpochTime time)
```
    Returns a new instance representing an instant zero length time range.
  - denull
```
public static EpochTimeRange denull(EpochTimeRange range_nullable)
```
  - from
```
public EpochTime from()
```
    Returns the "from" date passed into the constructor, or EpochTime.NULL if null was originally passed in.
  - to
```
public EpochTime to()
```
    Returns the "to" date passed into the constructor, or EpochTime.NULL if null was originally passed in.
  - isValid
```
public boolean isValid()
```
    Returns true if from() is less than or equal to to().
  - isInvalid
```
public boolean isInvalid()
```
    Returns true if from() is greater than to().
  - isZero
```
public boolean isZero()
```
    Returns true if from() and to() are equal.
  - getDelta
```
public long getDelta()
```
    Returns the raw milliseconds between from() and to().
  - isInvalidOrZero
```
public boolean isInvalidOrZero()
```
    See isInvalid() and isZero().
  - isNull
```
public boolean isNull()
```
    Returns true if this is referentially equal to NULL.
    
    Specified by:
    
    isNull in interface UsesCustomNull
  - lt
```
public boolean lt(EpochTimeRange otherRange)
```
    "less than" comparison.
  - lte
```
public boolean lte(EpochTimeRange otherRange)
```
    "less than or equal" comparison.
  - gt
```
public boolean gt(EpochTimeRange otherRange)
```
    "greater than" comparison.
  - gte
```
public boolean gte(EpochTimeRange otherRange)
```
    "greater than or equal" comparison.

Class EpochTimeRange

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NULL

FROM_MIN_TO_1970

FROM_MIN_TO_MAX

FROM_1970_TO_MAX

ZERO

FIVE_SECONDS

Constructor Detail

EpochTimeRange

EpochTimeRange

Method Detail

fromGiven_toMax

fromGiven_toNow

fromGiven_toGiven

from1970_toGiven

fromMin_toGiven

from1970_toNow

instant

denull

from

to

isValid

isInvalid

isZero

getDelta

isInvalidOrZero

isNull

lt

lte

gt

gte