/*
 * Copyright Terracotta, Inc.
 *
 * 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 org.ehcache.expiry;

import java.util.Objects;

Utility class for getting predefined Expiry instances. /**
 * Utility class for getting predefined {@link Expiry} instances.
 */
@Deprecated
public final class Expirations {

  
Get an Expiry instance for a non expiring (ie. "eternal") cache. 
Returns:
the no expiry instance
Deprecated:
Use org.ehcache.config.builders.ExpiryPolicyBuilder#noExpiration() instead/**
   * Get an {@link Expiry} instance for a non expiring (ie. "eternal") cache.
   *
   * @return the no expiry instance
   *
   * @deprecated Use {@code org.ehcache.config.builders.ExpiryPolicyBuilder#noExpiration()} instead
   */
  @Deprecated
  public static Expiry<Object, Object> noExpiration() {
    return NoExpiry.INSTANCE;
  }

  
Get a time-to-live (TTL) Expiry instance for the given Duration. 
Params:
timeToLive – the TTL duration
Returns:
a TTL expiry
Deprecated:
Use org.ehcache.config.builders.ExpiryPolicyBuilder#timeToLiveExpiration(java.time.Duration) instead/**
   * Get a time-to-live (TTL) {@link Expiry} instance for the given {@link Duration}.
   *
   * @param timeToLive the TTL duration
   * @return a TTL expiry
   *
   * @deprecated Use {@code org.ehcache.config.builders.ExpiryPolicyBuilder#timeToLiveExpiration(java.time.Duration)} instead
   */
  @Deprecated
  public static Expiry<Object, Object> timeToLiveExpiration(Duration timeToLive) {
    if (timeToLive == null) {
      throw new NullPointerException("Duration cannot be null");
    }
    return new TimeToLiveExpiry(timeToLive);
  }

  
Get a time-to-idle (TTI) Expiry instance for the given Duration. 
Params:
timeToIdle – the TTI duration
Returns:
a TTI expiry
Deprecated:
Use org.ehcache.config.builders.ExpiryPolicyBuilder#timeToIdleExpiration(java.time.Duration) instead/**
   * Get a time-to-idle (TTI) {@link Expiry} instance for the given {@link Duration}.
   *
   * @param timeToIdle the TTI duration
   * @return a TTI expiry
   *
   * @deprecated Use {@code org.ehcache.config.builders.ExpiryPolicyBuilder#timeToIdleExpiration(java.time.Duration)} instead
   */
  @Deprecated
  public static Expiry<Object, Object> timeToIdleExpiration(Duration timeToIdle) {
    if (timeToIdle == null) {
      throw new NullPointerException("Duration cannot be null");
    }
    return new TimeToIdleExpiry(timeToIdle);
  }

  
Fluent API for creating an Expiry instance where you can specify constant values for creation, access and update time. Unspecified values will be set to Duration.INFINITE for create and null for access and update, matching the no expiration expiry. 
Type parameters:
<K> – the key type for the cache
<V> – the value type for the cache
Returns:
an Expiry builder
Deprecated:
Use org.ehcache.config.builders.ExpiryPolicyBuilder#expiry() instead/**
   * Fluent API for creating an Expiry instance where you can specify constant values for creation, access and update time.
   * Unspecified values will be set to {@code Duration.INFINITE} for create and {@code null} for access and update, matching
   * the {@link #noExpiration() no expiration} expiry.
   *
   * @param <K> the key type for the cache
   * @param <V> the value type for the cache
   * @return an {@link Expiry} builder
   *
   * @deprecated Use {@code org.ehcache.config.builders.ExpiryPolicyBuilder#expiry()} instead
   */
  @Deprecated
  public static <K, V> ExpiryBuilder<K, V> builder() {
    return new ExpiryBuilder<>();
  }

  private Expirations() {
    //
  }

  
Simple implementation of the Expiry interface allowing to set constants to each expiry types. /**
   * Simple implementation of the {@link Expiry} interface allowing to set constants to each expiry types.
   */
  @Deprecated
  private static class BaseExpiry<K, V> implements Expiry<K, V> {

    private final Duration create;
    private final Duration access;
    private final Duration update;

    BaseExpiry(Duration create, Duration access, Duration update) {
      this.create = create;
      this.access = access;
      this.update = update;
    }

    @Override
    public Duration getExpiryForCreation(K key, V value) {
      return create;
    }

    @Override
    public Duration getExpiryForAccess(K key, org.ehcache.ValueSupplier<? extends V> value) {
      return access;
    }

    @Override
    public Duration getExpiryForUpdate(K key, org.ehcache.ValueSupplier<? extends V> oldValue, V newValue) {
      return update;
    }

    @Override
    public boolean equals(final Object o) {
      if (this == o) return true;
      if (o == null || getClass() != o.getClass()) return false;

      BaseExpiry<?, ?> that = (BaseExpiry<?, ?>)o;

      if (!Objects.equals(access, that.access)) return false;
      if (!Objects.equals(create, that.create)) return false;
      if (!Objects.equals(update, that.update)) return false;

      return true;
    }

    @Override
    public int hashCode() {
      int result = Objects.hashCode(create);
      result = 31 * result + Objects.hashCode(access);
      result = 31 * result + Objects.hashCode(update);
      return result;
    }

    @Override
    public String toString() {
      return this.getClass().getSimpleName() + "{" +
             "create=" + create +
             ", access=" + access +
             ", update=" + update +
             '}';
    }
  }

  @Deprecated
  private static class TimeToLiveExpiry extends BaseExpiry<Object, Object> {
    TimeToLiveExpiry(Duration ttl) {
      super(ttl, null, ttl);
    }
  }

  @Deprecated
  private static class TimeToIdleExpiry extends BaseExpiry<Object, Object> {
    TimeToIdleExpiry(Duration tti) {
      super(tti, tti, tti);
    }
  }

  @Deprecated
  private static class NoExpiry extends BaseExpiry<Object, Object> {

    private static final Expiry<Object, Object> INSTANCE = new NoExpiry();

    private NoExpiry() {
      super(Duration.INFINITE, null, null);
    }
  }

  
Builder to create a simple Expiry. 
Type parameters:
<K> – Key type of the cache entries
<V> – Value type of the cache entries/**
   * Builder to create a simple {@link Expiry}.
   *
   * @param <K> Key type of the cache entries
   * @param <V> Value type of the cache entries
   */
  @Deprecated
  public static final class ExpiryBuilder<K, V> {

    private Duration create = Duration.INFINITE;
    private Duration access = null;
    private Duration update = null;

    private ExpiryBuilder() {}

    
Set TTL since creation
Params:
create – TTL since creation
Returns:
this builder/**
     * Set TTL since creation
     *
     * @param create TTL since creation
     * @return this builder
     */
    public ExpiryBuilder<K, V> setCreate(Duration create) {
      this.create = create;
      return this;
    }

    
Set TTL since last access
Params:
access – TTL since last access
Returns:
this builder/**
     * Set TTL since last access
     *
     * @param access TTL since last access
     * @return this builder
     */
    public ExpiryBuilder<K, V> setAccess(Duration access) {
      this.access = access;
      return this;
    }

    
Set TTL since last update
Params:
update – TTL since last update
Returns:
this builder/**
     * Set TTL since last update
     *
     * @param update TTL since last update
     * @return this builder
     */
    public ExpiryBuilder<K, V> setUpdate(Duration update) {
      this.update = update;
      return this;
    }

    
Returns:
an Expiry/**
     *
     * @return an {@link Expiry}
     */
    public Expiry<K, V> build() {
      return new BaseExpiry<>(create, access, update);
    }
  }
}