/*
 * 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.spi.service.ServiceCreationConfiguration;

import java.util.Collection;
import java.util.Map;

Represents the configuration for a CacheManager. 

Implementations are expected to be read-only.
/**
 * Represents the configuration for a {@link org.ehcache.CacheManager CacheManager}.
 * <p>
 * <em>Implementations are expected to be read-only.</em>
 */
public interface Configuration {

  
Mapping of aliases to CacheConfigurations, used to configure the Caches managed by the CacheManager. 
 The map must not be null but can be empty. It must be unmodifiable. 
Returns:
a map of aliases to cache configurations/**
   * Mapping of aliases to {@link CacheConfiguration}s, used to configure the {@link org.ehcache.Cache Cache}s
   * managed by the {@link org.ehcache.CacheManager CacheManager}.
   * <p>
   * The map must not be {@code null} but can be empty. It must be unmodifiable.
   *
   * @return a map of aliases to cache configurations
   */
  Map<String, CacheConfiguration<?, ?>> getCacheConfigurations();

  
ServiceCreationConfiguration initially used to bootstrap the CacheManager and its Caches. 

The collection must not be null but can be empty. Also it must be unmodifiable.
Returns:
a collection of service creations configurations/**
   * {@link ServiceCreationConfiguration} initially used to bootstrap the {@link org.ehcache.CacheManager CacheManager}
   * and its {@link org.ehcache.Cache Cache}s.
   * <p>
   * The collection must not be null but can be empty. Also it must be unmodifiable.
   *
   * @return a collection of service creations configurations
   */
  Collection<ServiceCreationConfiguration<?, ?>> getServiceCreationConfigurations();

  
The ClassLoader for the CacheManager. 
 This ClassLoader will be used to instantiate cache manager level services and for Caches that do not have a specific ClassLoader. 
 The ClassLoader must not be null. 
Returns:
the cache manager ClassLoader/**
   * The {@link ClassLoader} for the {@link org.ehcache.CacheManager CacheManager}.
   * <p>
   * This {@code ClassLoader} will be used to instantiate cache manager level services
   * and for {@link org.ehcache.Cache Cache}s that do not have a specific {@code ClassLoader}.
   * <p>
   * The {@code ClassLoader} must not be null.
   *
   * @return the cache manager {@code ClassLoader}
   */
  ClassLoader getClassLoader();

  
Creates a builder seeded with this configuration.
 The default implementation throws UnsupportedOperationException to indicate that configuration derivation is not supported. 
Throws:
UnsupportedOperationException – if configuration derivation is not supported
See Also:
FluentConfigurationBuilder
Returns:
a configuration builder/**
   * Creates a builder seeded with this configuration.
   * <p>
   * The default implementation throws {@code UnsupportedOperationException} to indicate that configuration derivation
   * is not supported.
   *
   * @see FluentConfigurationBuilder
   * @return a configuration builder
   * @throws UnsupportedOperationException if configuration derivation is not supported
   */
  default FluentConfigurationBuilder<?> derive() {
    throw new UnsupportedOperationException();
  }
}