org.hawkular.metrics.model

Class Buckets

java.lang.Object

org.hawkular.metrics.model.Buckets

public final class Buckets
extends Object

Bucket configuration attributes. The configuration determines:

• the first point in time (getStart())
• the bucket size (getStep())
• the number of buckets (getCount())

Instances can be created with the constructor Buckets(long, long, int) or with one of the factory methods:

• fromStep(long, long, long)
• fromCount(long, long, int)

The former forces the size of buckets, the latter the number of buckets. The former is preferred has it guarantees that the last bucket will always include the end value.

Author:

Thomas Segismont

Constructor Summary

Constructors

Constructor and Description
Buckets(long start, long step, int count)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static Buckets	fromCount(long start, long end, int count) Force bucket count.
static Buckets	fromStep(long start, long end, long step) Force bucket step.
long	getBucketStart(int index)
int	getCount()
int	getIndex(long timestamp)
long	getStart()
long	getStep()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Buckets

public Buckets(long start,
               long step,
               int count)

Method Detail

getStart

public long getStart()

Returns:

start timestamp of the first bucket

getStep

public long getStep()

Returns:

size (in time) of a bucket

getCount

public int getCount()

Returns:

number of buckets

getIndex

public int getIndex(long timestamp)

Returns:

the index (starting from zero) of the bucket which the specified timestamp belongs to

getBucketStart

public long getBucketStart(int index)

Returns:

start timestamp of the bucket which position is specified by index

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

fromCount

public static Buckets fromCount(long start,
                                long end,
                                int count)

Force bucket count. This method does not guarantee that the last bucket includes the end value.

Parameters:

start - start time

end - end time

count - desired number of buckets

Returns:

an instance of Buckets, starting at start, separated by count intervals

fromStep

public static Buckets fromStep(long start,
                               long end,
                               long step)

Force bucket step.

Parameters:

start - start time

end - end time

step - desired step

Returns:

an instance of Buckets, starting at start, separated by intervals of size step