net.sf.ehcache.config.generator.ConfigurationGenerator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ehcache Show documentation

Ehcache is an open source, standards-based cache used to boost performance, offload the database and simplify scalability. Ehcache is robust, proven and full-featured and this has made it the most widely-used Java-based cache.

There is a newer version: 2.10.9.2

Show newest version

/**
 *  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 net.sf.ehcache.config.generator;

import java.util.Map;

import net.sf.ehcache.config.CacheConfiguration;
import net.sf.ehcache.config.Configuration;

/**
 * Utility class for generating configuration texts.
 *
 * 
 *
 * @author Abhishek Sanoujam
 * @deprecated Use {@link ConfigurationUtil#generateCacheManagerConfigurationText(Configuration)} or
 *             {@link ConfigurationUtil#generateCacheConfigurationText(Configuration, CacheConfiguration)} instead
 */
@Deprecated
public class ConfigurationGenerator {

    /**
     * Generates the configuration text for the provided {@link Configuration}, the default {@link CacheConfiguration} and the map of
     * {@link CacheConfiguration}'s
     *
     * @param configuration
     * @param defaultCacheConfiguration
     * @param cacheConfigs
     * @return String equivalent to an ehcache.xml for the input parameters
     * @deprecated use appropriate methods in {@link ConfigurationUtil} instead
     */
    @Deprecated
    public String generate(Configuration configuration, CacheConfiguration defaultCacheConfiguration,
            Map cacheConfigs) {
        return ConfigurationUtil.generateCacheManagerConfigurationText(configuration);
    }

    /**
     * Generates configuration text for a specific cache using the input {@link CacheConfiguration}
     *
     * @param cacheConfiguration
     * @return String containing configuration for the input {@link CacheConfiguration}
     * @deprecated use appropriate methods in {@link ConfigurationUtil} instead
     */
    @Deprecated
    public String generate(Configuration configuration, CacheConfiguration cacheConfiguration) {
        return ConfigurationUtil.generateCacheConfigurationText(configuration, cacheConfiguration);
    }

}