Index
All Classes and Interfaces|All Packages
A
- addBucket(Function<Bucket.Builder, Bucket>) - Method in class com.github.cowwoc.tokenbucket.ContainerList.Builder
-
Adds a Bucket to this list.
- addBucket(Function<Bucket.Builder, Bucket>) - Method in class com.github.cowwoc.tokenbucket.ContainerList.ConfigurationUpdater
-
Adds a Bucket to this list.
- addContainerList(Function<ContainerList.Builder, ContainerList>) - Method in class com.github.cowwoc.tokenbucket.ContainerList.Builder
-
Adds a ContainerList to this list.
- addContainerList(Function<ContainerList.Builder, ContainerList>) - Method in class com.github.cowwoc.tokenbucket.ContainerList.ConfigurationUpdater
-
Adds a ContainerList to this list.
- addLimit(Function<Limit.Builder, Limit>) - Method in class com.github.cowwoc.tokenbucket.Bucket.Builder
-
Adds a limit that the bucket must respect.
- addLimit(Function<Limit.Builder, Limit>) - Method in class com.github.cowwoc.tokenbucket.Bucket.ConfigurationUpdater
-
Adds a limit that the bucket must respect.
- addListener(ContainerListener) - Method in class com.github.cowwoc.tokenbucket.Bucket.Builder
-
Adds an event listener to the bucket.
- addListener(ContainerListener) - Method in class com.github.cowwoc.tokenbucket.Bucket.ConfigurationUpdater
-
Adds an event listener to the bucket.
- addListener(ContainerListener) - Method in class com.github.cowwoc.tokenbucket.ContainerList.Builder
-
Adds an event listener to the list.
- assertionsAreEnabled() - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Returns true if assertions are enabled for this class.
- assertionsAreEnabled() - Method in class com.github.cowwoc.requirements.Requirements
- assertThat(Consumer<Requirements>) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies requirements only if assertions are enabled.
- assertThat(Consumer<Requirements>) - Method in class com.github.cowwoc.requirements.Requirements
-
Verifies requirements only if
assertions are enabled
. - assertThatAndReturn(Function<Requirements, V>) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies requirements only if
assertions are enabled
. - assertThatAndReturn(Function<Requirements, V>) - Method in class com.github.cowwoc.requirements.Requirements
-
Verifies requirements only if
assertions are enabled
. - availableTokens() - Method in class com.github.cowwoc.tokenbucket.Limit.ConfigurationUpdater
-
Returns the number of available tokens.
- availableTokens(long) - Method in class com.github.cowwoc.tokenbucket.Limit.ConfigurationUpdater
-
Sets the number of available tokens.
B
- beforeSleep(Container, long, Instant, Instant, List<Limit>) - Method in interface com.github.cowwoc.tokenbucket.ContainerListener
-
Invoked before sleeping to wait for more tokens.
- Bucket - Class in com.github.cowwoc.tokenbucket
-
A container with Limits.
- Bucket.Builder - Class in com.github.cowwoc.tokenbucket
-
Builds a bucket.
- Bucket.ConfigurationUpdater - Class in com.github.cowwoc.tokenbucket
-
Updates this Bucket's configuration.
- build() - Method in class com.github.cowwoc.tokenbucket.Bucket.Builder
-
Builds a new Bucket.
- build() - Method in class com.github.cowwoc.tokenbucket.ContainerList.Builder
-
Builds a new ContainerList.
- build() - Method in class com.github.cowwoc.tokenbucket.Limit.Builder
-
Builds a new Limit.
- builder() - Static method in class com.github.cowwoc.tokenbucket.Bucket
-
Builds a new bucket.
- builder() - Static method in class com.github.cowwoc.tokenbucket.ContainerList
-
Builds a bucket that contains children buckets.
- Builder() - Constructor for class com.github.cowwoc.tokenbucket.Bucket.Builder
C
- children() - Method in class com.github.cowwoc.tokenbucket.ContainerList.Builder
-
Returns the children containers.
- children() - Method in class com.github.cowwoc.tokenbucket.ContainerList.ConfigurationUpdater
-
Returns the children containers.
- clear() - Method in class com.github.cowwoc.tokenbucket.Bucket.ConfigurationUpdater
-
Removes all limits.
- clear() - Method in class com.github.cowwoc.tokenbucket.ContainerList.ConfigurationUpdater
-
Removes all children from this list.
- close() - Method in class com.github.cowwoc.tokenbucket.Bucket.ConfigurationUpdater
-
Updates this Bucket's configuration.
- close() - Method in class com.github.cowwoc.tokenbucket.ContainerList.ConfigurationUpdater
-
Updates this ContainerList's configuration.
- close() - Method in class com.github.cowwoc.tokenbucket.Limit.ConfigurationUpdater
-
Updates this Limit's configuration and releases its lock.
- com.github.cowwoc.tokenbucket - module com.github.cowwoc.tokenbucket
-
The main module.
- com.github.cowwoc.tokenbucket - package com.github.cowwoc.tokenbucket
-
An implementation of the Token bucket algorithm.
- consume() - Method in class com.github.cowwoc.tokenbucket.Bucket
- consume() - Method in interface com.github.cowwoc.tokenbucket.Container
-
Consumes a single token, blocking until it becomes available.
- consume(long) - Method in class com.github.cowwoc.tokenbucket.Bucket
- consume(long) - Method in interface com.github.cowwoc.tokenbucket.Container
-
Consumes the specified number of tokens, blocking until they become available.
- consume(long, long) - Method in class com.github.cowwoc.tokenbucket.Bucket
- consume(long, long) - Method in interface com.github.cowwoc.tokenbucket.Container
-
Consumes
[minimumTokens, maximumTokens]
tokens, blocking until they become available. - CONSUME_FROM_ALL - Enum constant in enum class com.github.cowwoc.tokenbucket.ConsumptionPolicy
-
Consumes tokens from all children at the same time.
- CONSUME_FROM_ONE - Enum constant in enum class com.github.cowwoc.tokenbucket.ConsumptionPolicy
-
Consumes tokens from one child at a time.
- consumeFromAll() - Method in class com.github.cowwoc.tokenbucket.ContainerList.Builder
-
Indicates that the list should consume tokens from all children simultaneously.
- consumeFromAll() - Method in class com.github.cowwoc.tokenbucket.ContainerList.ConfigurationUpdater
-
Indicates that the list should consume tokens from all children simultaneously.
- consumeFromOne(SelectionPolicy) - Method in class com.github.cowwoc.tokenbucket.ContainerList.Builder
-
Indicates that the list should delegate to the first child that has sufficient number of tokens available.
- consumeFromOne(SelectionPolicy) - Method in class com.github.cowwoc.tokenbucket.ContainerList.ConfigurationUpdater
-
Indicates that the list should delegate to the first child that has sufficient number of tokens available.
- consumptionPolicy() - Method in class com.github.cowwoc.tokenbucket.ContainerList.Builder
-
Returns the consumption policy indicating how to consume tokens from children containers.
- consumptionPolicy() - Method in class com.github.cowwoc.tokenbucket.ContainerList.ConfigurationUpdater
-
Returns the consumption policy indicating how to consume tokens from children containers.
- ConsumptionPolicy - Enum Class in com.github.cowwoc.tokenbucket
-
Indicates how to consume tokens from children containers.
- ConsumptionResult - Class in com.github.cowwoc.tokenbucket
-
The result of an attempt to consume tokens.
- ConsumptionResult(Container, long, long, long, Instant, Instant, Instant, long, List<Limit>) - Constructor for class com.github.cowwoc.tokenbucket.ConsumptionResult
-
Creates a result of a request to consume tokens.
- Container - Interface in com.github.cowwoc.tokenbucket
-
A container of tokens.
- ContainerList - Class in com.github.cowwoc.tokenbucket
-
A container of one or more children containers.
- ContainerList.Builder - Class in com.github.cowwoc.tokenbucket
-
Builds a ContainerList.
- ContainerList.ConfigurationUpdater - Class in com.github.cowwoc.tokenbucket
-
Updates this ContainerList's configuration.
- ContainerListener - Interface in com.github.cowwoc.tokenbucket
-
Listens for container events.
- copy() - Method in class com.github.cowwoc.requirements.Requirements
-
Returns a copy of this configuration.
D
- DefaultRequirements - Class in com.github.cowwoc.requirements
-
Verifies requirements using the default
configuration
.
E
- equals(Object) - Method in class com.github.cowwoc.tokenbucket.ConsumptionResult
- equals(Object) - Method in class com.github.cowwoc.tokenbucket.Limit
G
- getAvailableAt() - Method in class com.github.cowwoc.tokenbucket.ConsumptionResult
-
Returns the time at which the requested tokens are expected to become available.
- getAvailableIn() - Method in class com.github.cowwoc.tokenbucket.ConsumptionResult
-
Returns the amount of time until the requested number of tokens will become available.
- getBottlenecks() - Method in class com.github.cowwoc.tokenbucket.ConsumptionResult
-
Returns the list of limits that are preventing tokens from being consumed.
- getBucket() - Method in class com.github.cowwoc.tokenbucket.Limit
-
Returns the bucket containing this limit.
- getChildren() - Method in interface com.github.cowwoc.tokenbucket.Container
-
Returns the children containers.
- getConsumeAt() - Method in class com.github.cowwoc.tokenbucket.ConsumptionResult
-
Returns the time at which an attempt was made to consume tokens.
- getContainer() - Method in class com.github.cowwoc.tokenbucket.ConsumptionResult
-
Returns the container that tokens were consumed from.
- getContext() - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Returns an unmodifiable map to append to the exception message.
- getContext() - Method in class com.github.cowwoc.requirements.Requirements
- getContextMessage(String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Returns the contextual information associated with this configuration.
- getContextMessage(String) - Method in class com.github.cowwoc.requirements.Requirements
- getInitialTokens() - Method in class com.github.cowwoc.tokenbucket.Limit
-
Returns the initial number of tokens that the bucket starts with.
- getLimits() - Method in class com.github.cowwoc.tokenbucket.Bucket
-
Returns the limits associated with this bucket.
- getLimitWithLowestRefillRate() - Method in class com.github.cowwoc.tokenbucket.Bucket
-
Returns the limit with the lowest refill rate.
- getListeners() - Method in class com.github.cowwoc.tokenbucket.Bucket
- getListeners() - Method in interface com.github.cowwoc.tokenbucket.Container
-
Returns the listeners associated with this container.
- getMaximumTokens() - Method in class com.github.cowwoc.tokenbucket.Limit
-
Returns the maximum number of tokens that the bucket may hold before overflowing (subsequent tokens are discarded).
- getMaximumTokensRequested() - Method in class com.github.cowwoc.tokenbucket.ConsumptionResult
-
Returns the maximum number of tokens that were requested.
- getMinimumTokensRequested() - Method in class com.github.cowwoc.tokenbucket.ConsumptionResult
-
Returns the minimum number of tokens that were requested.
- getPeriod() - Method in class com.github.cowwoc.tokenbucket.Limit
-
indicates how often
tokensPerPeriod
should be added to the bucket. - getRefillSize() - Method in class com.github.cowwoc.tokenbucket.Limit
-
Returns the number of tokens that are refilled at a time.
- getTokensConsumed() - Method in class com.github.cowwoc.tokenbucket.ConsumptionResult
-
Returns the number of tokens that were consumed by the request.
- getTokensLeft() - Method in class com.github.cowwoc.tokenbucket.ConsumptionResult
-
Returns the number of tokens left.
- getTokensPerPeriod() - Method in class com.github.cowwoc.tokenbucket.Limit
-
Returns the number of tokens to add every
period
. - getUserData() - Method in class com.github.cowwoc.tokenbucket.Bucket
- getUserData() - Method in interface com.github.cowwoc.tokenbucket.Container
-
Returns the data associated with this container.
- getUserData() - Method in class com.github.cowwoc.tokenbucket.Limit
-
Returns the data associated with this limit.
H
- hashCode() - Method in class com.github.cowwoc.tokenbucket.ConsumptionResult
- hashCode() - Method in class com.github.cowwoc.tokenbucket.Limit
I
- initialTokens() - Method in class com.github.cowwoc.tokenbucket.Limit.Builder
-
Returns the initial number of tokens in the bucket.
- initialTokens(long) - Method in class com.github.cowwoc.tokenbucket.Limit.Builder
-
Sets the initial number of tokens in the bucket.
- isCleanStackTrace() - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Indicates if stack trace references to this library should be removed.
- isCleanStackTrace() - Method in class com.github.cowwoc.requirements.Requirements
- isDiffEnabled() - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Indicates if exceptions should show the difference between the actual and expected values.
- isDiffEnabled() - Method in class com.github.cowwoc.requirements.Requirements
- isSuccessful() - Method in class com.github.cowwoc.tokenbucket.ConsumptionResult
-
Returns true if the bucket was able to consume any tokens.
L
- Limit - Class in com.github.cowwoc.tokenbucket
-
A rate limit.
- Limit.Builder - Class in com.github.cowwoc.tokenbucket
-
Builds a Limit.
- Limit.ConfigurationUpdater - Class in com.github.cowwoc.tokenbucket
-
Updates this Limit's configuration.
- limits() - Method in class com.github.cowwoc.tokenbucket.Bucket.Builder
-
Returns the limits that the bucket must respect.
- limits() - Method in class com.github.cowwoc.tokenbucket.Bucket.ConfigurationUpdater
-
Returns the limits that the bucket must respect.
- listeners() - Method in class com.github.cowwoc.tokenbucket.Bucket.Builder
-
Returns the event listeners associated with this bucket.
- listeners() - Method in class com.github.cowwoc.tokenbucket.ContainerList.Builder
-
Returns the event listeners associated with this list.
M
- maximumTokens() - Method in class com.github.cowwoc.tokenbucket.Limit.Builder
-
Returns the maximum number of tokens that the bucket may hold before overflowing.
- maximumTokens() - Method in class com.github.cowwoc.tokenbucket.Limit.ConfigurationUpdater
-
Returns the maximum number of tokens that the bucket may hold before overflowing.
- maximumTokens(long) - Method in class com.github.cowwoc.tokenbucket.Limit.Builder
-
Sets the maximum number of tokens that the bucket may hold before overflowing.
- maximumTokens(long) - Method in class com.github.cowwoc.tokenbucket.Limit.ConfigurationUpdater
-
Sets the maximum number of tokens that the bucket may hold before overflowing.
P
- period() - Method in class com.github.cowwoc.tokenbucket.Limit.Builder
-
Indicates how often
tokensPerPeriod
should be added to the bucket. - period() - Method in class com.github.cowwoc.tokenbucket.Limit.ConfigurationUpdater
-
Indicates how often
tokensPerPeriod
should be added to the bucket. - period(Duration) - Method in class com.github.cowwoc.tokenbucket.Limit.Builder
-
Indicates how often
tokensPerPeriod
should be added to the bucket. - period(Duration) - Method in class com.github.cowwoc.tokenbucket.Limit.ConfigurationUpdater
-
Indicates how often
tokensPerPeriod
should be added to the bucket.
R
- refillSize() - Method in class com.github.cowwoc.tokenbucket.Limit.Builder
-
Returns the number of tokens that are refilled at a time.
- refillSize() - Method in class com.github.cowwoc.tokenbucket.Limit.ConfigurationUpdater
-
Returns the number of tokens that are refilled at a time.
- refillSize(long) - Method in class com.github.cowwoc.tokenbucket.Limit.Builder
-
Sets the number of tokens that are refilled at a time.
- refillSize(long) - Method in class com.github.cowwoc.tokenbucket.Limit.ConfigurationUpdater
-
Sets the number of tokens that are refilled at a time.
- remove(Container) - Method in class com.github.cowwoc.tokenbucket.ContainerList.ConfigurationUpdater
-
Removes a child from this list.
- removeLimit(Limit) - Method in class com.github.cowwoc.tokenbucket.Bucket.ConfigurationUpdater
-
Removes a limit that the bucket must respect.
- removeListener(ContainerListener) - Method in class com.github.cowwoc.tokenbucket.Bucket.ConfigurationUpdater
-
Removes an event listener from the bucket.
- Requirements - Class in com.github.cowwoc.requirements
-
Verifies requirements using a thread-specific
configuration
. - Requirements() - Constructor for class com.github.cowwoc.requirements.Requirements
-
Creates a new instance of Requirements.
- requireThat(boolean[], String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a primitive
boolean
array. - requireThat(boolean[], String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(boolean, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a
boolean
. - requireThat(boolean, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(byte[], String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a primitive
byte
array. - requireThat(byte[], String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(byte, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a
byte
. - requireThat(byte, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(char[], String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a primitive
char
array. - requireThat(char[], String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(char, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a
char
. - requireThat(char, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(double[], String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a primitive
double
array. - requireThat(double[], String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(double, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a
double
. - requireThat(double, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(float[], String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a primitive
float
array. - requireThat(float[], String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(float, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a
float
. - requireThat(float, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(int[], String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a primitive
int
array. - requireThat(int[], String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(int, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of an
int
. - requireThat(int, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(long[], String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a primitive
long
array. - requireThat(long[], String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(long, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a
long
. - requireThat(long, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(short[], String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a primitive
short
array. - requireThat(short[], String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(short, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a
short
. - requireThat(short, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(C, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a
Collection
. - requireThat(C, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(E[], String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of an
Object
array. - requireThat(E[], String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(Boolean, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a
Boolean
. - requireThat(Boolean, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(Class<T>, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a
Class
. - requireThat(Class<T>, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(Double, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a
Double
. - requireThat(Double, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(Float, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a
Float
. - requireThat(Float, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(Integer, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of an
Integer
. - requireThat(Integer, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(Long, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a
Long
. - requireThat(Long, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(String, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a
String
. - requireThat(String, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(BigDecimal, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a
BigDecimal
. - requireThat(BigDecimal, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(InetAddress, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of an
InetAddress
. - requireThat(InetAddress, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(URI, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a
URI
. - requireThat(URI, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(URL, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a
URL
. - requireThat(URL, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(Path, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a
Path
. - requireThat(Path, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(Map<K, V>, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a
Map
. - requireThat(Map<K, V>, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(Optional<?>, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of an
Optional
. - requireThat(Optional<?>, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(L, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of a
List
. - requireThat(L, String) - Method in class com.github.cowwoc.requirements.Requirements
- requireThat(T, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Verifies the requirements of an
Object
. - requireThat(T, String) - Method in class com.github.cowwoc.requirements.Requirements
- ROUND_ROBIN - Enum constant in enum class com.github.cowwoc.tokenbucket.SelectionPolicy
-
A scheduler that selects the next bucket in a round-robin fashion.
S
- SelectionPolicy - Enum Class in com.github.cowwoc.tokenbucket
-
Selects a bucket from a list.
- size() - Method in class com.github.cowwoc.tokenbucket.ContainerList
-
Returns the number of children in this list.
T
- tokensPerPeriod() - Method in class com.github.cowwoc.tokenbucket.Limit.Builder
-
Returns the number of tokens to add to the bucket every
period
. - tokensPerPeriod() - Method in class com.github.cowwoc.tokenbucket.Limit.ConfigurationUpdater
-
Returns the number of tokens to add to the bucket every
period
. - tokensPerPeriod(long) - Method in class com.github.cowwoc.tokenbucket.Limit.Builder
-
Sets the number of tokens to add to the bucket every
period
. - tokensPerPeriod(long) - Method in class com.github.cowwoc.tokenbucket.Limit.ConfigurationUpdater
-
Sets the number of tokens to add to the bucket every
period
. - toString() - Method in class com.github.cowwoc.tokenbucket.Bucket.Builder
- toString() - Method in class com.github.cowwoc.tokenbucket.Bucket.ConfigurationUpdater
- toString() - Method in class com.github.cowwoc.tokenbucket.Bucket
- toString() - Method in class com.github.cowwoc.tokenbucket.ConsumptionResult
- toString() - Method in class com.github.cowwoc.tokenbucket.ContainerList.Builder
- toString() - Method in class com.github.cowwoc.tokenbucket.ContainerList.ConfigurationUpdater
- toString() - Method in class com.github.cowwoc.tokenbucket.ContainerList
- toString() - Method in class com.github.cowwoc.tokenbucket.Limit.Builder
- toString() - Method in class com.github.cowwoc.tokenbucket.Limit.ConfigurationUpdater
- toString() - Method in class com.github.cowwoc.tokenbucket.Limit
- toString(Object) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Returns the
String
representation of an object. - toString(Object) - Method in class com.github.cowwoc.requirements.Requirements
- tryConsume() - Method in class com.github.cowwoc.tokenbucket.Bucket
- tryConsume() - Method in interface com.github.cowwoc.tokenbucket.Container
-
Consumes a single token, only if one is available at the time of invocation.
- tryConsume(long) - Method in class com.github.cowwoc.tokenbucket.Bucket
- tryConsume(long) - Method in interface com.github.cowwoc.tokenbucket.Container
-
Consumes
tokens
tokens, only if they are available at the time of invocation. - tryConsume(long, long) - Method in class com.github.cowwoc.tokenbucket.Bucket
- tryConsume(long, long) - Method in interface com.github.cowwoc.tokenbucket.Container
-
Consumes
[minimumTokens, maximumTokens]
tokens, only if they are available at the time of invocation. - tryConsume(long, long, long, TimeUnit) - Method in class com.github.cowwoc.tokenbucket.Bucket
- tryConsume(long, long, long, TimeUnit) - Method in interface com.github.cowwoc.tokenbucket.Container
-
Consumes
[minimumTokens, maximumTokens]
tokens, only if they become available within the given waiting time. - tryConsume(long, long, TimeUnit) - Method in class com.github.cowwoc.tokenbucket.Bucket
- tryConsume(long, long, TimeUnit) - Method in interface com.github.cowwoc.tokenbucket.Container
-
Consumes the requested number of
tokens
, only if they become available within the given waiting time.
U
- updateConfiguration() - Method in class com.github.cowwoc.tokenbucket.Bucket
-
Updates this Bucket's configuration.
- updateConfiguration() - Method in class com.github.cowwoc.tokenbucket.ContainerList
-
Updates this list's configuration.
- updateConfiguration() - Method in class com.github.cowwoc.tokenbucket.Limit
-
Updates this Limit's configuration.
- userData() - Method in class com.github.cowwoc.tokenbucket.Bucket.Builder
-
Returns the user data associated with this bucket.
- userData() - Method in class com.github.cowwoc.tokenbucket.Bucket.ConfigurationUpdater
-
Returns the user data associated with this bucket.
- userData() - Method in class com.github.cowwoc.tokenbucket.ContainerList.Builder
-
Returns the user data associated with this list.
- userData() - Method in class com.github.cowwoc.tokenbucket.ContainerList.ConfigurationUpdater
-
Returns the user data associated with this list.
- userData() - Method in class com.github.cowwoc.tokenbucket.Limit.Builder
-
Returns user data associated with this limit.
- userData() - Method in class com.github.cowwoc.tokenbucket.Limit.ConfigurationUpdater
-
Returns the data associated with this limit.
- userData(Object) - Method in class com.github.cowwoc.tokenbucket.Bucket.Builder
-
Sets user data associated with this bucket.
- userData(Object) - Method in class com.github.cowwoc.tokenbucket.Bucket.ConfigurationUpdater
-
Sets user data associated with this bucket.
- userData(Object) - Method in class com.github.cowwoc.tokenbucket.ContainerList.Builder
-
Sets user data associated with this list.
- userData(Object) - Method in class com.github.cowwoc.tokenbucket.ContainerList.ConfigurationUpdater
-
Sets user data associated with this list.
- userData(Object) - Method in class com.github.cowwoc.tokenbucket.Limit.Builder
-
Sets user data associated with this limit.
- userData(Object) - Method in class com.github.cowwoc.tokenbucket.Limit.ConfigurationUpdater
-
Sets the data associated with this limit.
V
- validateThat(boolean[], String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a primitive
boolean
array. - validateThat(boolean[], String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(boolean, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a
boolean
. - validateThat(boolean, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(byte[], String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a primitive
byte
array. - validateThat(byte[], String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(byte, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a
byte
. - validateThat(byte, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(char[], String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a primitive
char
array. - validateThat(char[], String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(char, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a
char
. - validateThat(char, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(double[], String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a primitive
double
array. - validateThat(double[], String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(double, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a
double
. - validateThat(double, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(float[], String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a primitive
float
array. - validateThat(float[], String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(float, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a
float
. - validateThat(float, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(int[], String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a primitive
int
array. - validateThat(int[], String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(int, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of an
int
. - validateThat(int, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(long[], String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a primitive
long
array. - validateThat(long[], String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(long, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a
long
. - validateThat(long, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(short[], String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a primitive
short
array. - validateThat(short[], String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(short, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a
short
. - validateThat(short, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(C, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a
Collection
. - validateThat(C, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(E[], String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of an
Object
array. - validateThat(E[], String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(Boolean, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a
Boolean
. - validateThat(Boolean, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(Class<T>, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a
Class
. - validateThat(Class<T>, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(Double, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a
Double
. - validateThat(Double, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(Float, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a
Float
. - validateThat(Float, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(Integer, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of an
Integer
. - validateThat(Integer, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(Long, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a
Long
. - validateThat(Long, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(String, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a
String
. - validateThat(String, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(BigDecimal, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a
BigDecimal
. - validateThat(BigDecimal, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(InetAddress, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of an
InetAddress
. - validateThat(InetAddress, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(URI, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a
URI
. - validateThat(URI, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(URL, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a
URL
. - validateThat(URL, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(Path, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a
Path
. - validateThat(Path, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(Map<K, V>, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a
Map
. - validateThat(Map<K, V>, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(Optional<?>, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of an
Optional
. - validateThat(Optional<?>, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(L, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of a
List
. - validateThat(L, String) - Method in class com.github.cowwoc.requirements.Requirements
- validateThat(T, String) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Validates the requirements of an
Object
. - validateThat(T, String) - Method in class com.github.cowwoc.requirements.Requirements
- valueOf(String) - Static method in enum class com.github.cowwoc.tokenbucket.ConsumptionPolicy
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.cowwoc.tokenbucket.SelectionPolicy
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.github.cowwoc.tokenbucket.ConsumptionPolicy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.cowwoc.tokenbucket.SelectionPolicy
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- withAssertionsDisabled() - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Indicates that
assertThat()
shouldn't do anything. - withAssertionsDisabled() - Method in class com.github.cowwoc.requirements.Requirements
- withAssertionsEnabled() - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Indicates that
assertThat()
should verify requirements. - withAssertionsEnabled() - Method in class com.github.cowwoc.requirements.Requirements
- withCleanStackTrace() - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Indicates that stack trace references to this library should be removed.
- withCleanStackTrace() - Method in class com.github.cowwoc.requirements.Requirements
- withConfiguration(Configuration) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Replaces the configuration.
- withConfiguration(Configuration) - Method in class com.github.cowwoc.requirements.Requirements
- withContext(String, Object) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Adds or updates contextual information associated with the exception message.
- withContext(String, Object) - Method in class com.github.cowwoc.requirements.Requirements
- withDiff() - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Indicates that exceptions should show the difference between the actual and expected values.
- withDiff() - Method in class com.github.cowwoc.requirements.Requirements
- withoutAnyContext() - Method in class com.github.cowwoc.requirements.Requirements
- withoutCleanStackTrace() - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Indicates that stack trace references to this library should be kept.
- withoutCleanStackTrace() - Method in class com.github.cowwoc.requirements.Requirements
- withoutContext(String) - Method in class com.github.cowwoc.requirements.Requirements
- withoutDiff() - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Indicates that exceptions should not show the difference between the actual and expected values.
- withoutDiff() - Method in class com.github.cowwoc.requirements.Requirements
- withoutStringConverter(Class<T>) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Indicates that an object's
toString()
method should be used to convert it to a String. - withoutStringConverter(Class<T>) - Method in class com.github.cowwoc.requirements.Requirements
- withStringConverter(Class<T>, Function<T, String>) - Static method in class com.github.cowwoc.requirements.DefaultRequirements
-
Indicates that a function should be used to convert an object to a String.
- withStringConverter(Class<T>, Function<T, String>) - Method in class com.github.cowwoc.requirements.Requirements
All Classes and Interfaces|All Packages