io.github.bucket4j.local.LocalBucket 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.local;
import io.github.bucket4j.Bucket;
import io.github.bucket4j.BucketConfiguration;
import io.github.bucket4j.TimeMeter;
import java.io.IOException;
import java.util.Map;
/**
* Represents the bucket inside current JVM.
*/
public interface LocalBucket extends Bucket {
/**
* Returns configuration of this bucket.
*
* @return configuration
*/
BucketConfiguration getConfiguration();
/**
* Returns the clock that is used by this bucket
*
* @return the clock that is used by this bucket
*/
TimeMeter getTimeMeter();
/**
* Returns the synchronization strategy that is used by this bucket
*
* @return synchronization strategy that is used by this bucket
*/
SynchronizationStrategy getSynchronizationStrategy();
/**
* Takes the binary snapshot of this bucket that later can be used as parameter for {@link #fromBinarySnapshot(byte[])} to restore bucket from snapshot.
*
* @return the binary snapshot of this bucket
*/
default byte[] toBinarySnapshot() throws IOException {
return LocalBucketSerializationHelper.toBinarySnapshot(this);
}
/**
* Reconstructs a bucket from binary snapshot.
*
* @param snapshot binary snapshot
*
* @return bucket reconstructed from binary snapshot
*/
static LocalBucket fromBinarySnapshot(byte[] snapshot) throws IOException {
return LocalBucketSerializationHelper.fromBinarySnapshot(snapshot);
}
/**
* Takes the JSON snapshot of this bucket that later can be used as parameter for {@link #fromJsonCompatibleSnapshot(Map)} to restore bucket from snapshot.
*
* @return the map that transparently can be serialized to JSON via any JSON library
*/
default Map toJsonCompatibleSnapshot() throws IOException {
return LocalBucketSerializationHelper.toJsonCompatibleSnapshot(this);
}
/**
* Reconstructs a bucket from JSON snapshot.
*
* @param snapshot the snapshot Map that was deserialized from JSON via any JSON library
*
* @return bucket reconstructed from binary snapshot
*/
static LocalBucket fromJsonCompatibleSnapshot(Map snapshot) throws IOException {
return LocalBucketSerializationHelper.fromJsonCompatibleSnapshot(snapshot);
}
}