keycloakjar.com.github.benmanes.caffeine.cache.CacheWriter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of camunda-bpm-identity-keycloak-all Show documentation
Show all versions of camunda-bpm-identity-keycloak-all Show documentation
Camunda Keycloak Identity Provider Plugin including all transitive dependencies
The newest version!
/*
* Copyright 2015 Ben Manes. All Rights Reserved.
*
* 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.
*/
package com.github.benmanes.caffeine.cache;
import java.util.Map;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
/**
* Communicates the write or deletion of a value, based on a key, to an external resource. A writer
* is notified by the cache each time an entry is explicitly created or modified, or removed for any
* {@link RemovalCause reason}. The writer is not notified when an entry is loaded or computed.
*
* @author [email protected] (Ben Manes)
* @param the most general type of keys this writer can write; for example {@code Object} if any
* key is acceptable
* @param the most general type of values this write can write; for example {@code Object} if
* any value is acceptable
* @deprecated Scheduled for removal in version 3.0.0. Consider instead using {@link Map} compute
* methods for extending manual write and remove operations, and using
* {@link Caffeine#evictionListener(RemovalListener)} for extending removals due to
* eviction.
*/
@Deprecated
public interface CacheWriter {
/***
* Writes the value corresponding to the {@code key} to the external resource. The cache will
* communicate a write when an entry in the cache is created or modified, except when that was
* due to a load or computation.
*
* @param key the non-null key whose value should be written
* @param value the value associated with {@code key} that should be written
* @throws RuntimeException or Error, in which case the mapping is unchanged
*/
void write(@NonNull K key, @NonNull V value);
/**
* Deletes the value corresponding to the {@code key} from the external resource. The cache will
* communicate a delete when the entry is explicitly removed or evicted.
*
* @param key the non-null key whose value was removed
* @param value the value associated with {@code key}, or {@code null} if collected
* @param cause the reason for which the entry was removed
* @throws RuntimeException or Error, in which case the mapping is unchanged
*/
void delete(@NonNull K key, @Nullable V value, @NonNull RemovalCause cause);
/**
* Returns a writer that does nothing.
*
* @param the type of keys
* @param the type of values
* @return a writer that performs no operations
*/
static @NonNull CacheWriter disabledWriter() {
@SuppressWarnings("unchecked")
CacheWriter writer = (CacheWriter) DisabledWriter.INSTANCE;
return writer;
}
}
@SuppressWarnings("deprecation")
enum DisabledWriter implements CacheWriter