io.ebean.cache.QueryCacheEntry 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 java.util.Set;

/**
 * For query cache entries we additionally hold the dependent tables and timestamp for the query result.
 * 
 * We use the dependent tables and timestamp to validate that tables the query joins to have not been
 * modified since the query cache entry was cached. If any dependent tables have since been modified
 * the query cache entry is treated as invalid.
 * 
 */
public class QueryCacheEntry {

  private final Object value;
  private final Set dependentTables;
  private final long timestamp;

  /**
   * Create with dependent tables and timestamp.
   *
   * @param value           The query result being cached
   * @param dependentTables The extra tables the query is dependent on (joins to)
   * @param timestamp       The timestamp that the query uses to check for modifications
   */
  public QueryCacheEntry(Object value, Set dependentTables, long timestamp) {
    this.value = value;
    this.dependentTables = dependentTables;
    this.timestamp = timestamp;
  }

  /**
   * Return the actual query result.
   */
  public Object getValue() {
    return value;
  }

  /**
   * Return the tables the query result is dependent on.
   */
  public Set getDependentTables() {
    return dependentTables;
  }

  /**
   * Return the timestamp used to check for modifications on the dependent tables.
   */
  public long getTimestamp() {
    return timestamp;
  }
}