Package org.infinispan.container.entries

Class TransientCacheEntry

java.lang.Object
org.infinispan.container.entries.AbstractInternalCacheEntry
org.infinispan.container.entries.TransientCacheEntry
All Implemented Interfaces:
Cloneable, Map.Entry, CacheEntry, InternalCacheEntry, MetadataAware
public class TransientCacheEntry extends AbstractInternalCacheEntry
A cache entry that is transient, i.e., it can be considered expired after a period of not being used.
Since:
4.0
Author:
Manik Surtani

  • Field Details

    • maxIdle

      protected long maxIdle

    • lastUsed

      protected long lastUsed

  • Constructor Details

    • TransientCacheEntry

      public TransientCacheEntry(Object key, Object value, long maxIdle, long lastUsed)

    • TransientCacheEntry

      protected TransientCacheEntry(Object key, Object value, PrivateMetadata internalMetadata, long maxIdle, long lastUsed)

  • Method Details

    • touch

      public final void touch(long currentTimeMillis)
      Description copied from interface: InternalCacheEntry
      Updates access timestamps on this instance to a specified time
      Parameters:
      currentTimeMillis - the current time as defined by System.currentTimeMillis() or TimeService.wallClockTime()

    • reincarnate

      public void reincarnate(long now)
      Description copied from interface: InternalCacheEntry
      "Reincarnates" an entry. Essentially, resets the 'created' timestamp of the entry to the current time.
      Parameters:
      now - the current time as defined by System.currentTimeMillis() or TimeService.wallClockTime()

    • canExpire

      public final boolean canExpire()
      Returns:
      true if the entry can expire, false otherwise

    • canExpireMaxIdle

      public boolean canExpireMaxIdle()
      Returns:
      true if this entry can expire via max idle, false otherwise

    • isExpired

      public boolean isExpired(long now)
      Parameters:
      now - the current time as defined by System.currentTimeMillis() or TimeService.wallClockTime()
      Returns:
      true if the entry has expired; false otherwise

    • setMaxIdle

      public void setMaxIdle(long maxIdle)

    • getCreated

      public long getCreated()
      Returns:
      timestamp when the entry was created

    • getLastUsed

      public final long getLastUsed()
      Returns:
      timestamp when the entry was last used

    • getLifespan

      public long getLifespan()
      Returns:
      retrieves the lifespan of this entry. -1 means an unlimited lifespan.

    • getExpiryTime

      public long getExpiryTime()
      Description copied from interface: InternalCacheEntry
      Only used with entries that have a lifespan, this determines when an entry is due to expire.
      Returns:
      timestamp when the entry is due to expire, or -1 if it doesn't have a lifespan

    • getMaxIdle

      public final long getMaxIdle()
      Returns:
      the maximum allowed time for which this entry can be idle, after which it is considered expired.

    • toInternalCacheValue

      public InternalCacheValue<?> toInternalCacheValue()
      Description copied from interface: InternalCacheEntry
      Creates a representation of this entry as an InternalCacheValue. The main purpose of this is to provide a representation that does not have a reference to the key. This is useful in situations where the key is already known or stored elsewhere, making serialization and deserialization more efficient.

      Note that this should not be used to optimize memory overhead, since the saving of an additional reference to a key (a single object reference) does not warrant the cost of constructing an InternalCacheValue. This only makes sense when marshalling is involved, since the cost of marshalling the key again can be sidestepped using an InternalCacheValue if the key is already known/marshalled.

      Returns:
      a new InternalCacheValue encapsulating this InternalCacheEntry's value and expiration information.

    • getMetadata

      public Metadata getMetadata()
      Description copied from interface: MetadataAware
      Get metadata of this cache entry.
      Specified by:
      getMetadata in interface MetadataAware
      Overrides:
      getMetadata in class AbstractInternalCacheEntry
      Returns:
      a Metadata instance

    • setMetadata

      public void setMetadata(Metadata metadata)
      Description copied from interface: MetadataAware
      Set the metadata in the cache entry.
      Specified by:
      setMetadata in interface MetadataAware
      Overrides:
      setMetadata in class AbstractInternalCacheEntry
      Parameters:
      metadata - to apply to the cache entry

    • clone

      public TransientCacheEntry clone()
      Specified by:
      clone in interface CacheEntry
      Specified by:
      clone in interface InternalCacheEntry
      Overrides:
      clone in class AbstractInternalCacheEntry

    • appendFieldsToString

      protected void appendFieldsToString(StringBuilder builder)
      Overrides:
      appendFieldsToString in class AbstractInternalCacheEntry