/*
 * 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 java.util.Set;

A collection of resource pools that a Cache has at its disposal to store its mappings. 

Implementations must be immutable.
/**
 * A collection of {@link ResourcePool resource pools} that a {@link org.ehcache.Cache Cache} has at its disposal
 * to store its mappings.
 * <p>
 * <em>Implementations must be immutable.</em>
 */
public interface ResourcePools {

  
Gets a specific ResourcePool based on its type. 
Params:
resourceType – the type of resource the pool is tracking
Type parameters:
<P> – specific resource pool type
Returns:
the ResourcePool, or null if there is no pool of the requested type./**
   * Gets a specific {@link ResourcePool} based on its type.
   *
   * @param <P> specific resource pool type
   * @param resourceType the type of resource the pool is tracking
   *
   * @return the {@link ResourcePool}, or null if there is no pool of the requested type.
   */
  <P extends ResourcePool> P getPoolForResource(ResourceType<P> resourceType);

  
Gets the set of ResourceTypes present in the ResourcePools. 
Returns:
the set of ResourceType/**
   * Gets the set of {@link ResourceType}s present in the {@code ResourcePools}.
   *
   * @return the set of {@link ResourceType}
   */
  Set<ResourceType<?>> getResourceTypeSet();

  
Get a copy of this ResourcePools merged with the given ResourcePools, validating that the updates to the contained ResourcePools are legal. 
Params:
toBeUpdated – the ResourcePools to merge with the current one.
Throws:
IllegalArgumentException –      thrown when an illegal resource value is being given
UnsupportedOperationException – thrown when an unsupported update is requested
Returns:
a validated and merged ResourcePools/**
   * Get a copy of this {@code ResourcePools} merged with the given {@code ResourcePools}, validating that
   * the updates to the contained {@link ResourcePool}s are legal.
   *
   * @param toBeUpdated the {@code ResourcePools} to merge with the current one.
   * @return a validated and merged {@code ResourcePools}
   * @throws IllegalArgumentException      thrown when an illegal resource value is being given
   * @throws UnsupportedOperationException thrown when an unsupported update is requested
   */
  ResourcePools validateAndMerge(ResourcePools toBeUpdated) throws IllegalArgumentException, UnsupportedOperationException;

}