io.github.bucket4j.VerboseBucket Maven / Gradle / Ivy
The newest version!
/*-
* ========================LICENSE_START=================================
* Bucket4j
* %%
* Copyright (C) 2015 - 2020 Vladimir Bukhtoyarov
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* =========================LICENSE_END==================================
*/
package io.github.bucket4j;
/**
* Intent of this interface is to provide the verbose version of {@link Bucket} API.
* All methods obey the same semantic but its results are more verbose.
*/
public interface VerboseBucket {
/**
* Does the same that {@link Bucket#tryConsume(long)}
*/
VerboseResult tryConsume(long numTokens);
/**
* Does the same that {@link Bucket#consumeIgnoringRateLimits(long)}
*/
VerboseResult consumeIgnoringRateLimits(long tokens);
/**
* Does the same that {@link Bucket#tryConsumeAndReturnRemaining(long)}
*/
VerboseResult tryConsumeAndReturnRemaining(long numTokens);
/**
* Does the same that {@link Bucket#estimateAbilityToConsume(long)}
*/
VerboseResult estimateAbilityToConsume(long numTokens);
/**
* Does the same that {@link Bucket#tryConsumeAsMuchAsPossible()}
*/
VerboseResult tryConsumeAsMuchAsPossible();
/**
* Does the same that {@link Bucket#tryConsumeAsMuchAsPossible(long)}
*/
VerboseResult tryConsumeAsMuchAsPossible(long limit);
/**
* Does the same that {@link Bucket#getAvailableTokens()}
*/
VerboseResult getAvailableTokens();
/**
* Does the same that {@link Bucket#addTokens(long)}
*/
VerboseResult addTokens(long tokensToAdd);
/**
* Does the same that {@link Bucket#reset()}
*/
VerboseResult reset();
/**
* Does the same that {@link Bucket#forceAddTokens(long)}
*/
VerboseResult forceAddTokens(long tokensToAdd);
/**
* Does the same that {@link Bucket#replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy)}
*/
VerboseResult replaceConfiguration(BucketConfiguration newConfiguration, TokensInheritanceStrategy tokensInheritanceStrategy);
}