io.ebeaninternal.server.core.CacheOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebean Show documentation
composite of common runtime dependencies for all platforms
There is a newer version: 15.8.1
package io.ebeaninternal.server.core;

import io.ebean.annotation.Cache;

/**
 * Options for controlling cache behaviour for a given type.
 */
public class CacheOptions {

  /**
   * Instance when no caching is used.
   */
  public static final CacheOptions NO_CACHING = new CacheOptions();

  private static final String R0 = "r0";

  private static final CacheOptions INVALIDATE_QUERY_CACHE_R0 = new CacheOptions(true);

  private final boolean invalidateQueryCache;
  private final boolean enableBeanCache;
  private final boolean enableQueryCache;
  private final boolean readOnly;
  private final String[] naturalKey;
  private final String region;

  public static CacheOptions invalidateQueryCache(String region) {
    if (R0.equals(region)) {
      return INVALIDATE_QUERY_CACHE_R0;
    } else {
      return new CacheOptions(true, region);
    }
  }

  /**
   * Construct for no caching.
   */
  private CacheOptions() {
    this.invalidateQueryCache = false;
    this.enableBeanCache = false;
    this.enableQueryCache = false;
    this.readOnly = false;
    this.naturalKey = null;
    this.region = null;
  }

  /**
   * Construct for invalidateQueryCache.
   */
  private CacheOptions(boolean invalidateQueryCache) {
    this(invalidateQueryCache, R0);
  }

  private CacheOptions(boolean invalidateQueryCache, String region) {
    this.invalidateQueryCache = invalidateQueryCache;
    this.enableBeanCache = false;
    this.enableQueryCache = false;
    this.readOnly = false;
    this.naturalKey = null;
    this.region = region;
  }

  /**
   * Construct with cache annotation.
   */
  public CacheOptions(Cache cache, String[] naturalKey) {
    this.invalidateQueryCache = false;
    this.enableBeanCache = cache.enableBeanCache();
    this.enableQueryCache = cache.enableQueryCache();
    this.readOnly = cache.readOnly();
    this.naturalKey = naturalKey;
    this.region = cache.region();
  }

  /**
   * Return the cache region name.
   */
  public String getRegion() {
    return region;
  }

  /**
   * Return true if this is InvalidateQueryCache. A Bean that itself isn't L2
   * cached but invalidates query cache entries that join to it.
   */
  public boolean isInvalidateQueryCache() {
    return invalidateQueryCache;
  }

  /**
   * Return true if bean caching is enabled.
   */
  public boolean isEnableBeanCache() {
    return enableBeanCache;
  }

  /**
   * Return true if query caching is enabled.
   */
  public boolean isEnableQueryCache() {
    return enableQueryCache;
  }

  /**
   * Return true if bean cache hits default to read only.
   */
  public boolean isReadOnly() {
    return readOnly;
  }

  /**
   * Return the natural key property name.
   */
  public String[] getNaturalKey() {
    return naturalKey;
  }
}