| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You 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 org.apache.ignite.cache.eviction; |
| |
| import javax.cache.Cache; |
| import org.jetbrains.annotations.Nullable; |
| |
| /** |
| * Evictable cache entry passed into {@link EvictionPolicy}. |
| * |
| * @author @java.author |
| * @version @java.version |
| */ |
| public interface EvictableEntry<K, V> extends Cache.Entry<K, V> { |
| /** |
| * Evicts entry associated with given key from cache. Note, that entry will be evicted |
| * only if it's not used (not participating in any locks or transactions). |
| * |
| * @return {@code True} if entry could be evicted, {@code false} otherwise. |
| */ |
| public boolean evict(); |
| |
| /** |
| * Checks whether entry is currently present in cache or not. If entry is not in |
| * cache (e.g. has been removed) {@code false} is returned. In this case all |
| * operations on this entry will cause creation of a new entry in cache. |
| * |
| * @return {@code True} if entry is in cache, {@code false} otherwise. |
| */ |
| public boolean isCached(); |
| |
| /** |
| * Returns entry size in bytes. |
| * |
| * @return entry size in bytes. |
| */ |
| public int size(); |
| |
| /** |
| * Gets metadata added by eviction policy. |
| * |
| * @param <T> Type of the metadata value. |
| * @return Metadata value or {@code null}. |
| */ |
| @Nullable public <T> T meta(); |
| |
| /** |
| * Adds a new metadata. |
| * |
| * @param val Metadata value. |
| * @param <T> Type of the metadata value. |
| * @return Metadata previously added, or |
| * {@code null} if there was none. |
| */ |
| @Nullable public <T> T addMeta(T val); |
| |
| /** |
| * Adds given metadata value only if it was absent. |
| * |
| * @param val Value to add if it's not attached already. |
| * @param <T> Type of the metadata value. |
| * @return {@code null} if new value was put, or current value if put didn't happen. |
| */ |
| @Nullable public <T> T putMetaIfAbsent(T val); |
| |
| /** |
| * Replaces given metadata with new {@code newVal} value only if its current value |
| * is equal to {@code curVal}. Otherwise, it is no-op. |
| * |
| * @param curVal Current value to check. |
| * @param newVal New value. |
| * @param <T> Type of the metadata value. |
| * @return {@code true} if replacement occurred, {@code false} otherwise. |
| */ |
| public <T> boolean replaceMeta(T curVal, T newVal); |
| |
| /** |
| * Removes metadata by name. |
| * |
| * @param <T> Type of the metadata value. |
| * @return Value of removed metadata or {@code null}. |
| */ |
| @Nullable public <T> T removeMeta(); |
| |
| /** |
| * Removes metadata only if its current value is equal to {@code val} passed in. |
| * |
| * @param val Value to compare. |
| * @param <T> Type of the metadata value. |
| * @return {@code True} if value was removed, {@code false} otherwise. |
| */ |
| public <T> boolean removeMeta(T val); |
| } |