org.ehcache.spi.loaderwriter.BulkCacheLoadingException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ehcache-api Show documentation
The API module of Ehcache 3
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.spi.loaderwriter;

import java.util.Collections;
import java.util.Map;

/**
 * Thrown by a {@link org.ehcache.Cache Cache} when its {@link CacheLoaderWriter}
 * fails while bulk loading values.
 */
public class BulkCacheLoadingException extends CacheLoadingException {

  private static final long serialVersionUID = -5296309607929568779L;

  private final Map failures;
  private final Map successes;

  /**
   * Constructs a {@code BulkCacheLoadingException} instance with the given maps.
   * 
   * The two maps are:
   * 

   *   a map from keys to exception thrown while loading,
   *   a map from keys to value where loading succeeded
   * 
   *
   * @param failures the map of keys to failure encountered while loading
   * @param successes the map of keys successfully loaded and their associated value
   */
  public BulkCacheLoadingException(Map failures, Map successes) {
    this.failures = Collections.unmodifiableMap(failures);
    this.successes = Collections.unmodifiableMap(successes);
  }

  /**
   * Constructs a new exception instance with the given message and maps.
   * 
   * The given two maps are:
   * 

   *   a map from keys to exception thrown while loading,
   *   a map from keys to value where loading succeeded
   * 
   *
   * @param message the exception message
   * @param failures the map of keys to failure encountered while loading
   * @param successes the map of keys successfully loaded and their associated value
   */
  public BulkCacheLoadingException(String message, final Map failures, Map successes) {
    super(message);
    this.failures = Collections.unmodifiableMap(failures);
    this.successes = Collections.unmodifiableMap(successes);
  }

  /**
   * Returns the map of keys to exception.
   *
   * @return a map of keys to the exception encountered while loading
   */
  public Map getFailures() {
    return failures;
  }

  /**
   * Returns the map of keys to value.
   *
   * @return a map of keys to the value loaded
   */
  public Map getSuccesses() {
    return successes;
  }
}