org.cache2k.AdvancedKeyValueSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cache2k-api Show documentation

A light weight and high performance Java cache library. API only jar.

There is a newer version: 2.6.1.Final

package org.cache2k;

/*
 * #%L
 * cache2k API
 * %%
 * Copyright (C) 2000 - 2016 headissue GmbH, Munich
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import java.util.Map;

/**
 * Key/value source with bulk get and prefetching.
 *
 * @author Jens Wilke
 * @since 1.0
 */
public interface AdvancedKeyValueSource extends KeyValueSource {

  /**
   * Retrieves all objects via the key. For a more detailed descriptions see
   * the cache interface.
   *
   * @see Cache#getAll(Iterable)
   */
  Map getAll(Iterable keys);

  /**
   * Notify about the intend to retrieve the value for this key in the
   * near future. For a more detailed descriptions see
   * the cache interface.
   *
   * @see Cache#prefetch(Object)
   */
  void prefetch(K key);

  /**
   * Notify about the intend to retrieve the value for this key in the
   * near future. For a more detailed descriptions see
   * the cache interface.
   *
   * @see Cache#prefetch(CacheOperationCompletionListener, Object)
   */
  void prefetch(CacheOperationCompletionListener listener, K key);

  /**
   * Notify about the intend to retrieve the value for the keys in the
   * near future.
   *
   * @see Cache#prefetchAll(Iterable)
   */
  void prefetchAll(Iterable keys);

  /**
   * Notify about the intend to retrieve the value for the keys in the
   * near future.
   *
   * @see Cache#prefetchAll(CacheOperationCompletionListener, Iterable)
   */
  void prefetchAll(CacheOperationCompletionListener listener, Iterable keys);

  /**
   * Notify about the intend to retrieve the value for the keys in the
   * near future.
   *
   * @see Cache#prefetchAll(CacheOperationCompletionListener, Object[])
   */
  void prefetchAll(CacheOperationCompletionListener listener, K... keys);

}