org.cache2k.jcache.ExtendedMutableConfiguration 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 caching library. Android and Java 6 compatible. This artifact contains the official API of cache2k.

There is a newer version: 2.6.1.Final

Show newest version

package org.cache2k.jcache;

/*
 * #%L
 * cache2k API
 * %%
 * Copyright (C) 2000 - 2020 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 org.cache2k.Cache2kBuilder;
import org.cache2k.configuration.Cache2kConfiguration;

import javax.cache.configuration.Factory;
import javax.cache.configuration.MutableConfiguration;

/**
 * Extends the JCache mutable configuration with an additional cache2k configuration.
 *
 * @author Jens Wilke
 */
public final class ExtendedMutableConfiguration
  extends MutableConfiguration implements ExtendedConfiguration {

  /**
   * The preferred way to construct a JCache based on a cache2k configuration.
   * It is not needed to set any original parameters from {@link MutableConfiguration}.
   * It is possible to set parameters defined by JCache, e.g.
   * {@link MutableConfiguration#setCacheLoaderFactory(Factory)}. In this case the
   * settings will be merged. See the documentation.
   *
   * @see User Guide - JCache
   */
  public static  ExtendedMutableConfiguration of(Cache2kBuilder builder) {
    return of(builder.toConfiguration());
  }

  public static  ExtendedMutableConfiguration of(
    Cache2kConfiguration configuration) {
    ExtendedMutableConfiguration cfg = new ExtendedMutableConfiguration();
    cfg.cache2kConfiguration = configuration;
    return cfg;
  }

  private Cache2kConfiguration cache2kConfiguration;

  public Cache2kConfiguration getCache2kConfiguration() {
    return cache2kConfiguration;
  }

  public void setCache2kConfiguration(final Cache2kConfiguration cache2kConfiguration) {
    this.cache2kConfiguration = cache2kConfiguration;
  }

}