Package org.infinispan.counter.impl.manager

Interface InternalCounterAdmin

All Known Implementing Classes:

AbstractStrongCounter, BoundedStrongCounter, UnboundedStrongCounter, WeakCounterImpl

public interface InternalCounterAdmin

Internal interface which abstract the StrongCounter and WeakCounter.

Since:

14.0

Method Summary

Modifier and Type	Method	Description
default StrongCounter	asStrongCounter()
default WeakCounter	asWeakCounter()
CompletionStage<Void>	destroy()	Destroys the counter.
boolean	isWeakCounter()	Checks if the counter is a WeakCounter.
CompletionStage<Void>	reset()	Resets the counter to its initial value.
CompletionStage<Long>	value()	Returns the counter's value.

Method Details

asStrongCounter

default StrongCounter asStrongCounter()

Returns:

The StrongCounter instance or throws an CounterException if the counter is not a StrongCounter.

asWeakCounter

default WeakCounter asWeakCounter()

Returns:

The WeakCounter instance or throws an CounterException if the counter is not a WeakCounter.

destroy

CompletionStage<Void> destroy()

Destroys the counter.

It drops the counter's value and all listeners registered.

Returns:

A CompletionStage instance which is completed when the operation finishes.

reset

CompletionStage<Void> reset()

Resets the counter to its initial value.

Returns:

A CompletionStage instance which is completed when the operation finishes.

value

CompletionStage<Long> value()

Returns the counter's value.

Returns:

A CompletionStage instance which is completed when the operation finishes.

isWeakCounter

boolean isWeakCounter()

Checks if the counter is a WeakCounter.

If true, ensures asWeakCounter() never throws an CounterException. Otherwise, it ensures asStrongCounter() never throws an CounterException.

Returns:

true if the counter is WeakCounter.