Module com.github.cowwoc.tokenbucket

Package com.github.cowwoc.tokenbucket

Class Bucket.ConfigurationUpdater

java.lang.Object

com.github.cowwoc.tokenbucket.Bucket.ConfigurationUpdater

All Implemented Interfaces:

AutoCloseable

Enclosing class:

Bucket

public final class Bucket.ConfigurationUpdater
extends Object
implements AutoCloseable

Updates this Bucket's configuration.

Thread-safety: This class is not thread-safe.

Method Summary

Modifier and Type	Method	Description
Bucket.ConfigurationUpdater	addLimit(Function<Limit.Builder,Limit> limitBuilder)	Adds a limit that the bucket must respect.
Bucket.ConfigurationUpdater	addListener(ContainerListener listener)	Adds an event listener to the bucket.
Bucket.ConfigurationUpdater	clear()	Removes all limits.
void	close()	Updates this Bucket's configuration.
List<Limit>	limits()	Returns the limits that the bucket must respect.
Bucket.ConfigurationUpdater	removeLimit(Limit limit)	Removes a limit that the bucket must respect.
Bucket.ConfigurationUpdater	removeListener(ContainerListener listener)	Removes an event listener from the bucket.
String	toString()
Object	userData()	Returns the user data associated with this bucket.
Bucket.ConfigurationUpdater	userData(Object userData)	Sets user data associated with this bucket.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

limits

public List<Limit> limits()

Returns the limits that the bucket must respect.

Returns:

the limits that the bucket must respect

Throws:

IllegalStateException - if the updater is closed

addLimit

public Bucket.ConfigurationUpdater addLimit(Function<Limit.Builder,Limit> limitBuilder)

Adds a limit that the bucket must respect.

Parameters:

limitBuilder - builds a Limit

Returns:

this

Throws:

NullPointerException - if limit is null

IllegalStateException - if the updater is closed

removeLimit

public Bucket.ConfigurationUpdater removeLimit(Limit limit)

Removes a limit that the bucket must respect.

Parameters:

limit - a limit

Returns:

this

Throws:

NullPointerException - if limit is null

IllegalStateException - if the updater is closed

clear

public Bucket.ConfigurationUpdater clear()

Removes all limits.

Returns:

this

Throws:

IllegalStateException - if the updater is closed

addListener

public Bucket.ConfigurationUpdater addListener(ContainerListener listener)

Adds an event listener to the bucket.

Parameters:

listener - a listener

Returns:

this

Throws:

NullPointerException - if listener is null

IllegalStateException - if the updater is closed

removeListener

public Bucket.ConfigurationUpdater removeListener(ContainerListener listener)

Removes an event listener from the bucket.

Parameters:

listener - a listener

Returns:

this

Throws:

NullPointerException - if listener is null

IllegalStateException - if the updater is closed

userData

public Object userData()

Returns the user data associated with this bucket.

Returns:

the data associated with this bucket

Throws:

IllegalStateException - if the updater is closed

userData

public Bucket.ConfigurationUpdater userData(Object userData)

Sets user data associated with this bucket.

Parameters:

userData - the data associated with this bucket

Returns:

this

Throws:

IllegalStateException - if the updater is closed

close

public void close()

Updates this Bucket's configuration.

Specified by:

close in interface AutoCloseable

Throws:

IllegalArgumentException - if limits is empty

toString

public String toString()

Overrides:

toString in class Object