Module com.github.cowwoc.tokenbucket

Package com.github.cowwoc.tokenbucket

Enum Class ConsumptionPolicy

java.lang.Object

java.lang.Enum<ConsumptionPolicy>

com.github.cowwoc.tokenbucket.ConsumptionPolicy

All Implemented Interfaces:

Serializable, Comparable<ConsumptionPolicy>, Constable

public enum ConsumptionPolicy
extends Enum<ConsumptionPolicy>

Indicates how to consume tokens from children containers.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONSUME_FROM_ALL	Consumes tokens from all children at the same time.
CONSUME_FROM_ONE	Consumes tokens from one child at a time.

Method Summary

Modifier and Type	Method	Description
static ConsumptionPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ConsumptionPolicy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CONSUME_FROM_ONE

public static final ConsumptionPolicy CONSUME_FROM_ONE

Consumes tokens from one child at a time.

CONSUME_FROM_ALL

public static final ConsumptionPolicy CONSUME_FROM_ALL

Consumes tokens from all children at the same time.

Method Details

values

public static ConsumptionPolicy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ConsumptionPolicy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null