io.ebean.cache.ServerCacheOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebean-api Show documentation
ebean api
There is a newer version: 15.8.0
package io.ebean.cache;

import io.ebean.annotation.CacheBeanTuning;
import io.ebean.annotation.CacheQueryTuning;

/**
 * Options for controlling a cache.
 */
public class ServerCacheOptions {

  private int maxSize;
  private int maxIdleSecs;
  private int maxSecsToLive;
  private int trimFrequency;
  private boolean nearCache;

  /**
   * Construct with no set options.
   */
  public ServerCacheOptions() {
  }

  /**
   * Create from the cacheTuning deployment annotation.
   */
  public ServerCacheOptions(CacheBeanTuning tuning) {
    this.maxSize = tuning.maxSize();
    this.maxIdleSecs = tuning.maxIdleSecs();
    this.maxSecsToLive = tuning.maxSecsToLive();
    this.trimFrequency = tuning.trimFrequency();
  }

  /**
   * Create from the cacheTuning deployment annotation.
   */
  public ServerCacheOptions(CacheQueryTuning cacheTuning) {
    this.maxSize = cacheTuning.maxSize();
    this.maxIdleSecs = cacheTuning.maxIdleSecs();
    this.maxSecsToLive = cacheTuning.maxSecsToLive();
    this.trimFrequency = cacheTuning.trimFrequency();
  }

  /**
   * Create with nearCache option.
   */
  public ServerCacheOptions(boolean nearCache, CacheBeanTuning tuning) {
    this(tuning);
    this.nearCache = nearCache;
  }

  /**
   * Apply any settings from the default settings that have not already been
   * specifically set.
   */
  public ServerCacheOptions applyDefaults(ServerCacheOptions defaults) {
    if (maxSize == 0) {
      maxSize = defaults.getMaxSize();
    }
    if (maxIdleSecs == 0) {
      maxIdleSecs = defaults.getMaxIdleSecs();
    }
    if (maxSecsToLive == 0) {
      maxSecsToLive = defaults.getMaxSecsToLive();
    }
    if (trimFrequency == 0) {
      trimFrequency = defaults.getTrimFrequency();
    }
    return this;
  }

  /**
   * Return a copy of this object.
   */
  public ServerCacheOptions copy() {
    ServerCacheOptions copy = new ServerCacheOptions();
    copy.maxSize = maxSize;
    copy.maxIdleSecs = maxIdleSecs;
    copy.maxSecsToLive = maxSecsToLive;
    copy.trimFrequency = trimFrequency;
    copy.nearCache = this.nearCache;
    return copy;
  }

  /**
   * Return a copy of this object with nearCache option.
   */
  public ServerCacheOptions copy(boolean nearCache) {
    ServerCacheOptions copy = copy();
    copy.nearCache = nearCache;
    return copy;
  }

  /**
   * Return true if nearCache was explicitly turned on.
   */
  public boolean isNearCache() {
    return nearCache;
  }

  /**
   * Turn on nearCache option.
   */
  public void setNearCache(boolean nearCache) {
    this.nearCache = nearCache;
  }

  /**
   * Return the maximum cache size.
   */
  public int getMaxSize() {
    return maxSize;
  }

  /**
   * Set the maximum cache size.
   */
  public void setMaxSize(int maxSize) {
    this.maxSize = maxSize;
  }

  /**
   * Return the maximum idle time.
   */
  public int getMaxIdleSecs() {
    return maxIdleSecs;
  }

  /**
   * Set the maximum idle time.
   */
  public void setMaxIdleSecs(int maxIdleSecs) {
    this.maxIdleSecs = maxIdleSecs;
  }

  /**
   * Return the maximum time to live.
   */
  public int getMaxSecsToLive() {
    return maxSecsToLive;
  }

  /**
   * Set the maximum time to live.
   */
  public void setMaxSecsToLive(int maxSecsToLive) {
    this.maxSecsToLive = maxSecsToLive;
  }

  /**
   * Return the trim frequency in seconds.
   */
  public int getTrimFrequency() {
    return trimFrequency;
  }

  /**
   * Set the trim frequency in seconds.
   */
  public void setTrimFrequency(int trimFrequency) {
    this.trimFrequency = trimFrequency;
  }
}