com.helger.quartz.utils.counter.sampled

Class SampledRateCounter

java.lang.Object

com.helger.quartz.utils.counter.Counter

com.helger.quartz.utils.counter.sampled.SampledCounter

com.helger.quartz.utils.counter.sampled.SampledRateCounter

All Implemented Interfaces:

ICounter, ISampledCounter, ISampledRateCounter

public class SampledRateCounter
extends SampledCounter
implements ISampledRateCounter

An implementation of ISampledRateCounter

Since:

1.8

Author:

Abhishek Sanoujam

Field Summary

Fields inherited from class com.helger.quartz.utils.counter.sampled.SampledCounter

m_aHistory, m_bResetOnSample

Constructor Summary

Constructors

Constructor and Description
SampledRateCounter(SampledRateCounterConfig config) Constructor accepting the config

Method Summary

Modifier and Type	Method and Description
long	decrement() throws UnsupportedOperationException
long	decrement(long amount) throws UnsupportedOperationException
void	decrement(long numerator, long denominator) Decrements the numerator and denominator by the passed values
long	getAndReset() Returns the current value of the counter and resets it to 0
long	getAndSet(long newValue) throws UnsupportedOperationException
long	getMaxValue() throws UnsupportedOperationException
long	getMinValue() throws UnsupportedOperationException
long	getValue() Gets current value of the counter
long	increment() throws UnsupportedOperationException
long	increment(long amount) throws UnsupportedOperationException
void	increment(long numerator, long denominator) Increments the numerator and denominator by the passed values
void	setDenominatorValue(long newValue) Sets the value of the denominator to the passed value
void	setNumeratorValue(long newValue) Sets the value of the numerator to the passed value
void	setValue(long newValue) throws UnsupportedOperationException
void	setValue(long numerator, long denominator) Sets the values of the numerator and denominator to the passed values

Methods inherited from class com.helger.quartz.utils.counter.sampled.SampledCounter

getAllSampleValues, getIntervalMillis, getMostRecentSample, getTimerTask, shutdown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.helger.quartz.utils.counter.sampled.ISampledCounter

getAllSampleValues, getMostRecentSample, shutdown

Constructor Detail

SampledRateCounter

public SampledRateCounter(@Nonnull
                          SampledRateCounterConfig config)

Constructor accepting the config

Parameters:

config - config

Method Detail

setValue

public void setValue(long numerator,
                     long denominator)

Sets the values of the numerator and denominator to the passed values

Specified by:

setValue in interface ISampledRateCounter

increment

public void increment(long numerator,
                      long denominator)

Increments the numerator and denominator by the passed values

Specified by:

increment in interface ISampledRateCounter

decrement

public void decrement(long numerator,
                      long denominator)

Decrements the numerator and denominator by the passed values

Specified by:

decrement in interface ISampledRateCounter

setDenominatorValue

public void setDenominatorValue(long newValue)

Sets the value of the denominator to the passed value

Specified by:

setDenominatorValue in interface ISampledRateCounter

setNumeratorValue

public void setNumeratorValue(long newValue)

Sets the value of the numerator to the passed value

Specified by:

setNumeratorValue in interface ISampledRateCounter

getValue

public long getValue()

Gets current value of the counter

Specified by:

getValue in interface ICounter

Overrides:

getValue in class Counter

Returns:

current value of the counter

getAndReset

public long getAndReset()

Returns the current value of the counter and resets it to 0

Specified by:

getAndReset in interface ISampledCounter

Overrides:

getAndReset in class SampledCounter

Returns:

current value of the counter

getAndSet

public long getAndSet(long newValue)

throws UnsupportedOperationException

Specified by:

getAndSet in interface ICounter

Overrides:

getAndSet in class Counter

Returns:

Returns the old value

setValue

public void setValue(long newValue)

throws UnsupportedOperationException

Specified by:

setValue in interface ICounter

Overrides:

setValue in class Counter

decrement

public long decrement()

throws UnsupportedOperationException

Specified by:

decrement in interface ICounter

Overrides:

decrement in class Counter

Returns:

the value after decrementing

decrement

public long decrement(long amount)

throws UnsupportedOperationException

Specified by:

decrement in interface ICounter

Returns:

the value of the counter after decrementing

getMaxValue

public long getMaxValue()

throws UnsupportedOperationException

getMinValue

public long getMinValue()

throws UnsupportedOperationException

increment

public long increment()

throws UnsupportedOperationException

Specified by:

increment in interface ICounter

Overrides:

increment in class Counter

Returns:

the value after incrementing

increment

public long increment(long amount)

throws UnsupportedOperationException

Specified by:

increment in interface ICounter

Overrides:

increment in class Counter

Returns:

the value of the counter after incrementing