How to use org.eclipse.persistence.descriptors.invalidation

/**
 * PUBLIC:
 * Construct a daily policy that will allow objects to expire at a specific time of day.
 * Provide the hour, minute, second and millisecond.  Objects that make use of this policy
 * will be set to expire at that exact time every day.
 */
public DailyCacheInvalidationPolicy(int hour, int minute, int second, int millisecond) {
  setExpiryTime(hour, minute, second, millisecond);
}

/**
 * PUBLIC:
 * Build a QueryResultsCachePolicy with the default settings
 * By default there is no invalidation of query results and the maximum
 * number of results sets is 100.
 */
public QueryResultsCachePolicy() {
  this(new NoExpiryCacheInvalidationPolicy(), 100);
}

/**
 * INTERNAL:
 * Return the remaining life of this object
 */
public long getRemainingValidTime(CacheKey key) {
  long expiryTime = getExpiryTimeInMillis(key);
  long remainingTime = expiryTime - System.currentTimeMillis();
  if (remainingTime > 0) {
    return remainingTime;
  }
  return 0;
}

/**
 * INTERNAL:
 * Return the next expiry time.
 */
public long getExpiryTimeInMillis(CacheKey key) {
  incrementExpiry();
  return this.expiryTime.getTimeInMillis();
}

/**
 * INTERNAL:
 * return true if this object is expire, false otherwise.
 */
public abstract boolean isInvalidated(CacheKey key, long currentTimeMillis);

/**
 * INTERNAL:
 * Return true if this object is set as invalid or has expired.
 */
public boolean isInvalidated(CacheKey key, long currentTimeMillis) {
  if (key.getInvalidationState() == CacheKey.CACHE_KEY_INVALID) {
    return true;
  }
  return getExpiryTimeInMillis(key) <= currentTimeMillis;
}

  public Object clone() {
    TimeToLiveCacheInvalidationPolicy clone = null;

    try {
      clone = (TimeToLiveCacheInvalidationPolicy)super.clone();
      clone.timeToLive = this.timeToLive;
    } catch (Exception exception) {
      throw new InternalError("clone failed");
    }

    return clone;
  }
}

/**
 * PUBLIC:
 * Build a QueryResultsCachePolicy and supply a maximum for the number of results sets.
 * Results will be set not to expire in the cache.
 */
public QueryResultsCachePolicy(int maximumResultSets) {
  this(new NoExpiryCacheInvalidationPolicy(), maximumResultSets);
}

/**
 * PUBLIC:
 * Construct a daily policy that will allow objects to expire at a specific time of day.
 * Provide the hour, minute, second and millisecond.  Objects that make use of this policy
 * will be set to expire at that exact time every day.
 */
public DailyCacheInvalidationPolicy(int hour, int minute, int second, int millisecond) {
  setExpiryTime(hour, minute, second, millisecond);
}

/**
 * INTERNAL:
 * Return the remaining life of this object
 */
public long getRemainingValidTime(CacheKey key) {
  long expiryTime = getExpiryTimeInMillis(key);
  long remainingTime = expiryTime - System.currentTimeMillis();
  if (remainingTime > 0) {
    return remainingTime;
  }
  return 0;
}

/**
 * INTERNAL:
 * Return the next expiry time.
 */
public long getExpiryTimeInMillis(CacheKey key) {
  incrementExpiry();
  return this.expiryTime.getTimeInMillis();
}

  public Object clone() {
    TimeToLiveCacheInvalidationPolicy clone = null;

    try {
      clone = (TimeToLiveCacheInvalidationPolicy)super.clone();
      clone.timeToLive = this.timeToLive;
    } catch (Exception exception) {
      throw new InternalError("clone failed");
    }

    return clone;
  }
}

/**
 * PUBLIC:
 * Build a QueryResultsCachePolicy with the default settings
 * By default there is no invalidation of query results and the maximum
 * number of results sets is 100.
 */
public QueryResultsCachePolicy() {
  this(new NoExpiryCacheInvalidationPolicy(), 100);
}

/**
 * PUBLIC:
 * Construct a daily policy that will allow objects to expire at a specific time of day.
 * Provide the hour, minute, second and millisecond.  Objects that make use of this policy
 * will be set to expire at that exact time every day.
 */
public DailyCacheInvalidationPolicy(int hour, int minute, int second, int millisecond) {
  setExpiryTime(hour, minute, second, millisecond);
}

/**
 * PUBLIC:
 * Build a QueryResultsCachePolicy with the default settings
 * By default there is no invalidation of query results and the maximum
 * number of results sets is 100.
 */
public QueryResultsCachePolicy() {
  this(new NoExpiryCacheInvalidationPolicy(), 100);
}

/**
 * PUBLIC:
 * Return the CacheInvalidationPolicy for this descriptor
 * For uninitialized cache invalidation policies, this will return a NoExpiryCacheInvalidationPolicy
 * @return CacheInvalidationPolicy
 * @see org.eclipse.persistence.descriptors.invalidation.CacheInvalidationPolicy
 */
public CacheInvalidationPolicy getCacheInvalidationPolicy() {
  if (cacheInvalidationPolicy == null) {
    cacheInvalidationPolicy = new NoExpiryCacheInvalidationPolicy();
  }
  return cacheInvalidationPolicy;
}

/**
 * PUBLIC:
 * Return the CacheInvalidationPolicy for this descriptor
 * For uninitialized cache invalidation policies, this will return a NoExpiryCacheInvalidationPolicy
 * @return CacheInvalidationPolicy
 * @see org.eclipse.persistence.descriptors.invalidation.CacheInvalidationPolicy
 */
public CacheInvalidationPolicy getCacheInvalidationPolicy() {
  if (cacheInvalidationPolicy == null) {
    cacheInvalidationPolicy = new NoExpiryCacheInvalidationPolicy();
  }
  return cacheInvalidationPolicy;
}

/**
 * PUBLIC:
 * Build a QueryResultsCachePolicy and supply a maximum for the number of results sets.
 * Results will be set not to expire in the cache.
 */
public QueryResultsCachePolicy(int maximumResultSets) {
  this(new NoExpiryCacheInvalidationPolicy(), maximumResultSets);
}

/**
 * PUBLIC:
 * Build a QueryResultsCachePolicy and supply a maximum for the number of results sets.
 * Results will be set not to expire in the cache.
 */
public QueryResultsCachePolicy(int maximumResultSets) {
  this(new NoExpiryCacheInvalidationPolicy(), maximumResultSets);
}

/**
 * PUBLIC:
 * Return the CacheInvalidationPolicy for this descriptor
 * For uninitialized cache invalidation policies, this will return a NoExpiryCacheInvalidationPolicy
 * @return CacheInvalidationPolicy
 * @see org.eclipse.persistence.descriptors.invalidation.CacheInvalidationPolicy
 */
public CacheInvalidationPolicy getCacheInvalidationPolicy() {
  if (cacheInvalidationPolicy == null) {
    cacheInvalidationPolicy = new NoExpiryCacheInvalidationPolicy();
  }
  return cacheInvalidationPolicy;
}