org.beangle.commons.cache.Cache.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of beangle-commons Show documentation

The Beangle Commons Library

The newest version!

/*
 * Copyright (C) 2005, The Beangle Software.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 */

package org.beangle.commons.cache

/**
 * Common interface of Cache
 *
 * @author chaostone
 * @since 3.2.0
 */
trait Cache[K, V] {

  /**
   * Get Some(T) or None
   */
  def get(key: K): Option[V]

  /**
   * Put a new Value
   */
  def put(key: K, value: V): Unit

  /**
   * Touch the key,restart ttl
   * The default implementation is equivalent to
   * {{{
   *  val v = cache.get(k)
   *  if(v.isEmpty) false
   *  else {
   *    cache.remove(k)
   *    cache.put(k,v.get)
   *    true
   *  }
   * }}}
   * @return false if key not exists
   */
  def touch(key: K): Boolean

  /**
   * Exists key
   */
  def exists(key: K): Boolean

  /**
   * Same with put,but return true when absent
   */
  def putIfAbsent(key: K, value: V): Boolean

  /**
   * return Some(v) when exists old value
   */
  def replace(key: K, value: V): Option[V]

  /**
   * return true is (k,oldvalue) exists
   */
  def replace(key: K, oldvalue: V, newvalue: V): Boolean

  /**
   * Evict specified key
   */
  def evict(key: K): Boolean

  /**
   * Remove all mappings from the cache.
   */
  def clear(): Unit

  /**
   * Time to live seconds,-1 is forever
   */
  def ttl: Long

  /**
   * Time to idle seconds,-1 is forever
   */
  def tti: Long
}