Package org.elasticsearch.common
Class Rounding
org.elasticsearch.common.Rounding
- All Implemented Interfaces:
Writeable
A strategy for rounding milliseconds since epoch.
There are two implementations for rounding. The first one requires a date time unit and rounds to the supplied date time unit (i.e. quarter of year, day of month). The second one allows you to specify an interval to round to.
See blog for some background reading. Its super interesting and the links are a comedy gold mine. If you like time zones. Or hate them.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static interface
A strategy for rounding milliseconds since epoch.Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Rounding.Builder
builder(Rounding.DateTimeUnit unit)
static Rounding.Builder
builder(org.elasticsearch.core.TimeValue interval)
abstract boolean
obj)
abstract int
hashCode()
abstract byte
id()
abstract void
innerWriteTo(StreamOutput out)
long
nextRoundingValue(long utcMillis)
Deprecated.abstract long
offset()
Deprecated.We're in the process of abstracting offset *into* Rounding so keep any usage to migratory shimsabstract Rounding.Prepared
prepare(long minUtcMillis, long maxUtcMillis)
Prepare to round many times.abstract Rounding.Prepared
Prepare to round many dates over an unknown range.static Rounding
read(StreamInput in)
long
round(long utcMillis)
Deprecated.Preferprepare(long, long)
and thenRounding.Prepared.round(long)
abstract Rounding
Strip theoffset
from these bounds.void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class java.lang.
, , , , , , , ,
-
Constructor Details
-
Rounding
public Rounding()
-
-
Method Details
-
innerWriteTo
- Throws:
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
id
public abstract byte id() -
prepare
Prepare to round many times. -
prepareForUnknown
Prepare to round many dates over an unknown range. Preferprepare(long, long)
if you can find the range because it'll be much more efficient. -
round
public final long round(long utcMillis)Deprecated.Preferprepare(long, long)
and thenRounding.Prepared.round(long)
Rounds the given value. -
nextRoundingValue
public final long nextRoundingValue(long utcMillis)Deprecated.Preferprepare(long, long)
and thenRounding.Prepared.nextRoundingValue(long)
Given the rounded value (which was potentially generated byround(long)
, returns the next rounding value. For example, with interval based rounding, if the interval is 3,nextRoundValue(6) = 9
. -
offset
public abstract long offset()Deprecated.We're in the process of abstracting offset *into* Rounding so keep any usage to migratory shimsHow "offset" this rounding is from the traditional "start" of the period. -
withoutOffset
Strip theoffset
from these bounds. -
equals
public abstract boolean equals( obj)- Overrides:
in class
-
hashCode
public abstract int hashCode()- Overrides:
in class
-
builder
-
builder
-
read
- Throws:
-
prepare(long, long)
and thenRounding.Prepared.nextRoundingValue(long)