Record Class FixedDurationTtlFunction

java.lang.Object
java.lang.Record
org.springframework.data.redis.cache.FixedDurationTtlFunction
All Implemented Interfaces:
RedisCacheWriter.TtlFunction
public record FixedDurationTtlFunction(Duration duration) extends Record implements RedisCacheWriter.TtlFunction
RedisCacheWriter.TtlFunction implementation returning the given, predetermined Duration used for per cache entry time-to-live (TTL) expiration.
Since:
3.2
Author:
Mark Paluch, John Blum
See Also:

  • Constructor Details

    • FixedDurationTtlFunction

      public FixedDurationTtlFunction(Duration duration)
      Creates an instance of a FixedDurationTtlFunction record class.
      Parameters:
      duration - the value for the duration record component

  • Method Details

    • getTimeToLive

      public Duration getTimeToLive(Object key, @Nullable Object value)
      Description copied from interface: RedisCacheWriter.TtlFunction
      Compute a time-to-live (TTL) using the cache key and value.

      The time-to-live (TTL) is computed on each write operation. Redis uses millisecond granularity for timeouts. Any more granular values (e.g. micros or nanos) are not considered and will be truncated due to rounding. Returning Duration.ZERO, or a value less than Duration.ofMillis(1), results in a persistent value that does not expire.

      Specified by:
      getTimeToLive in interface RedisCacheWriter.TtlFunction
      Parameters:
      key - the cache key.
      value - the cache value. Can be null if the cache supports null value caching.
      Returns:
      the computed time-to-live (TTL). Can be Duration.ZERO for persistent values (i.e. cache entry does not expire).

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • duration

      public Duration duration()
      Returns the value of the duration record component.
      Returns:
      the value of the duration record component