package org.cache2k.expiry;

/*
 * #%L
 * cache2k API
 * %%
 * Copyright (C) 2000 - 2016 headissue GmbH, Munich
 * %%
 * 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.
 * #L%
 */

/**
 * Expiry time values that have a special meaning. Used for expressive return values in the
 * customizations {@link org.cache2k.integration.ResiliencePolicy} and {@link ExpiryPolicy}
 * as well as {@link org.cache2k.Cache#expireAt(Object, long)}.
 *
 * @author Jens Wilke
 */
public interface ExpiryTimeValues {

  /**
   * Don't change the expiry of the entry. This can be used for an update.
   */
  long NEUTRAL = -1;

  /**
   * Value should not be cached. In a read through configuration the value will be
   * reloaded, when it is requested again.
   */
  long NO_CACHE = 0;

  /**
   * Identical value to {@link #NO_CACHE}, meaningful when used together with
   * {@link org.cache2k.Cache#expireAt}. The value expires immediately. An immediate
   * load is triggered if refreshAhead is enabled.
   */
  long NOW = 0;

  /**
   * If refresh ahead is enabled, the value will be cached and visible. An immediate
   * load is triggered if refreshAhead is enabled. If the refresh is not possible, for example because of
   * no loader threads are available the value will expire.
   */
  long REFRESH = 1;

  /**
   * Return value signalling to keep the value forever in the cache, switching off expiry.
   * If the cache has a static expiry time configured, then this is used instead.
   */
  long ETERNAL = Long.MAX_VALUE;

}

@@ -1289,22 +1289,16 @@
 entical 
-value 
 to %7B@lin
@@ -1309,17 +1309,22 @@
 O_CACHE%7D
-,
+. More
  meaning
@@ -1524,75 +1524,8 @@
    *
- If refresh ahead is enabled, the value will be cached and visible.
  An 
@@ -1525,37 +1525,32 @@
   * An immediate
-%0A   *
  load is trigger
@@ -1601,16 +1601,21 @@
 h is not
+%0A   *
  possibl
@@ -1639,21 +1639,16 @@
 cause of
-%0A   *
  no load
@@ -1695,16 +1695,314 @@
 expire.%0A
+   *%0A   * %3Cp%3EAfter the load operation is completed, the entry is in a special area and not accessible%0A   * by direct cache operations, meaning %7B@code containsKey%7D returns false. After an operation which%0A   * triggers a load (e.g. %7B@code get%7D or %7B@code loadAll%7D, the entry is included in the cache.%0A
    */%0A  

improve refresh documentation