Module com.github.cowwoc.tokenbucket

Package com.github.cowwoc.tokenbucket

Class ContainerList.ConfigurationUpdater

java.lang.Object

com.github.cowwoc.tokenbucket.ContainerList.ConfigurationUpdater

All Implemented Interfaces:

AutoCloseable

Enclosing class:

ContainerList

public final class ContainerList.ConfigurationUpdater
extends Object
implements AutoCloseable

Updates this ContainerList's configuration.

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

Method Summary

Modifier and Type	Method	Description
ContainerList.ConfigurationUpdater	addBucket(Function<Bucket.Builder,Bucket> bucketBuilder)	Adds a Bucket to this list.
ContainerList.ConfigurationUpdater	addContainerList(Function<ContainerList.Builder,ContainerList> listBuilder)	Adds a ContainerList to this list.
List<Container>	children()	Returns the children containers.
ContainerList.ConfigurationUpdater	clear()	Removes all children from this list.
void	close()	Updates this ContainerList's configuration.
ContainerList.ConfigurationUpdater	consumeFromAll()	Indicates that the list should consume tokens from all children simultaneously.
ContainerList.ConfigurationUpdater	consumeFromOne(SelectionPolicy selectionPolicy)	Indicates that the list should delegate to the first child that has sufficient number of tokens available.
ConsumptionPolicy	consumptionPolicy()	Returns the consumption policy indicating how to consume tokens from children containers.
ContainerList.ConfigurationUpdater	remove(Container child)	Removes a child from this list.
String	toString()
Object	userData()	Returns the user data associated with this list.
ContainerList.ConfigurationUpdater	userData(Object userData)	Sets user data associated with this list.

Methods inherited from class java.lang.Object

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

Method Details

consumptionPolicy

public ConsumptionPolicy consumptionPolicy()

Returns the consumption policy indicating how to consume tokens from children containers.

Returns:

the consumption policy

Throws:

IllegalStateException - if the updater is closed

consumeFromOne

public ContainerList.ConfigurationUpdater consumeFromOne(SelectionPolicy selectionPolicy)

Indicates that the list should delegate to the first child that has sufficient number of tokens available.

Parameters:

selectionPolicy - determines the order in which buckets are evaluated

Returns:

this

Throws:

NullPointerException - if selectionPolicy is null

IllegalStateException - if the updater is closed

consumeFromAll

public ContainerList.ConfigurationUpdater consumeFromAll()

Indicates that the list should consume tokens from all children simultaneously.

Returns:

this

Throws:

IllegalStateException - if the updater is closed

children

public List<Container> children()

Returns the children containers.

Returns:

the children containers

Throws:

IllegalStateException - if the updater is closed

addBucket

public ContainerList.ConfigurationUpdater addBucket(Function<Bucket.Builder,Bucket> bucketBuilder)

Adds a Bucket to this list.

Parameters:

bucketBuilder - builds the Bucket

Returns:

this

Throws:

NullPointerException - if bucketBuilder is null

IllegalStateException - if the updater is closed

addContainerList

public ContainerList.ConfigurationUpdater addContainerList(Function<ContainerList.Builder,ContainerList> listBuilder)

Adds a ContainerList to this list.

Parameters:

listBuilder - builds the ContainerList

Returns:

this

Throws:

NullPointerException - if listBuilder is null

IllegalStateException - if the updater is closed

remove

public ContainerList.ConfigurationUpdater remove(Container child)

Removes a child from this list.

Parameters:

child - a child

Returns:

this

Throws:

NullPointerException - if child is null

IllegalStateException - if the updater is closed

clear

public ContainerList.ConfigurationUpdater clear()

Removes all children from this list.

Returns:

this

Throws:

IllegalStateException - if the updater is closed

userData

public Object userData()

Returns the user data associated with this list.

Returns:

the data associated with this list

Throws:

IllegalStateException - if the updater is closed

userData

public ContainerList.ConfigurationUpdater userData(Object userData)

Sets user data associated with this list.

Parameters:

userData - the data associated with this list

Returns:

this

Throws:

IllegalStateException - if the updater is closed

close

public void close()

Updates this ContainerList's configuration.

Specified by:

close in interface AutoCloseable

Throws:

IllegalArgumentException - if children is empty

toString

public String toString()

Overrides:

toString in class Object