org.ehcache.config.CacheConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ehcache Show documentation
End-user ehcache3 jar artifact
There is a newer version: 3.10.8
/*
 * Copyright Terracotta, Inc.
 *
 * 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.
 */

package org.ehcache.config;

import org.ehcache.Cache;
import org.ehcache.expiry.Expiry;
import org.ehcache.spi.service.ServiceConfiguration;

import java.util.Collection;

/**
 * Represents the minimal configuration for a {@link Cache}.
 * 
 *   Implementations are expected to be read-only.
 * 
 *
 * @param  the key type for the cache
 * @param  the value type for the cache
 */
public interface CacheConfiguration {

  /**
   * The service configurations defined for the {@link Cache}.
   * 
   *   Implementations must return an unmodifiable collection.
   * 
   *
   * @return service configurations
   */
  Collection> getServiceConfigurations();

  /**
   * The key type for the {@link Cache}.
   * 
   *   The key type must not be {@code null}.
   * 
   *
   * @return a non {@code null} class
   */
  Class getKeyType();

  /**
   * The value type for the {@link Cache}.
   * 
   *   The value type must not be {@code null}.
   * 
   *
   * @return a non {@code null} class
   */
  Class getValueType();

  /**
   * The {@link EvictionAdvisor} predicate function.
   * 
   * Entries which pass this predicate may be ignored by the eviction process.
   * This is only a hint.
   * 
   *
   * @return the eviction advisor predicate
   */
  EvictionAdvisor getEvictionAdvisor();

  /**
   * The {@link ClassLoader} for the {@link Cache}.
   * 
   *   This {@code ClassLoader} will be used to instantiate cache level services
   *   and for deserializing cache entries when required.
   * 
   * 
   *   The {@code ClassLoader} must not be null.
   * 
   *
   * @return the cache {@code ClassLoader}
   */
  ClassLoader getClassLoader();

  /**
   * The {@link Expiry} rules for the {@link Cache}.
   * 
   *   The {@code Expiry} cannot be null.
   * 
   *
   *  @return the {@code Expiry}
   */
  Expiry getExpiry();

  /**
   * The {@link ResourcePools} for the {@link Cache}.
   * 
   *   The {@code ResourcePools} cannot be null nor empty.
   * 
   *
   * @return the {@link ResourcePools}
   */
  ResourcePools getResourcePools();

}