|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.math3.util.Incrementor
public class Incrementor
Utility that increments a counter until a maximum is reached, at
which point, the instance will by default throw a
MaxCountExceededException.
However, the user is able to override this behaviour by defining a
custom callback, in order to e.g.
select which exception must be thrown.
| Nested Class Summary | |
|---|---|
static interface |
Incrementor.MaxCountExceededCallback
Defines a method to be called at counter exhaustion. |
| Constructor Summary | |
|---|---|
Incrementor()
Default constructor. |
|
Incrementor(int max)
Defines a maximal count. |
|
Incrementor(int max,
Incrementor.MaxCountExceededCallback cb)
Defines a maximal count and a callback method to be triggered at counter exhaustion. |
|
| Method Summary | |
|---|---|
boolean |
canIncrement()
Checks whether a single increment is allowed. |
int |
getCount()
Gets the current count. |
int |
getMaximalCount()
Gets the upper limit of the counter. |
void |
incrementCount()
Adds one to the current iteration count. |
void |
incrementCount(int value)
Performs multiple increments. |
void |
resetCount()
Resets the counter to 0. |
void |
setMaximalCount(int max)
Sets the upper limit for the counter. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public Incrementor()
setMaximalCount.
public Incrementor(int max)
max - Maximal count.
public Incrementor(int max,
Incrementor.MaxCountExceededCallback cb)
max - Maximal count.cb - Function to be called when the maximal count has been reached.
NullArgumentException - if cb is null| Method Detail |
|---|
public void setMaximalCount(int max)
resetCount()).
max - Upper limit of the counter.public int getMaximalCount()
public int getCount()
public boolean canIncrement()
false if the next call to incrementCount will trigger a MaxCountExceededException,
true otherwise.public void incrementCount(int value)
incrementCount method).
value - Number of increments.
MaxCountExceededException - at counter exhaustion.public void incrementCount()
trigger method of the
callback object passed to the
constructor.
If not explictly set, a default callback is used that will throw
a MaxCountExceededException.
MaxCountExceededException - at counter exhaustion, unless a
custom callback has been set at
construction.public void resetCount()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||