LogConfigurationException.java

/*
 * Copyright 2001-2004 The Apache Software Foundation.
 * 
 * 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.apache.commons.logging;

/**
 * <p>
 * An exception that is thrown only if a suitable <code>LogFactory</code> or
 * <code>Log</code> instance cannot be created by the corresponding factory
 * methods.
 * </p>
 * 
 * <p>
 * In this version of JCL, this exception will never be thrown in practice.
 * However, it is included here to ensure total compile time and run time
 * compatibility with the original JCL 1.0.4.
 * 
 * @author Craig R. McClanahan
 */

public class LogConfigurationException extends RuntimeException {

  private static final long serialVersionUID = 8486587136871052495L;

  /**
   * Construct a new exception with <code>null</code> as its detail message.
   */
  public LogConfigurationException() {
    super();
  }

  /**
   * Construct a new exception with the specified detail message.
   * 
   * @param message
   *          The detail message
   */
  public LogConfigurationException(String message) {
    super(message);
  }

  /**
   * Construct a new exception with the specified cause and a derived detail
   * message.
   * 
   * @param cause
   *          The underlying cause
   */
  public LogConfigurationException(Throwable cause) {

    this((cause == null) ? null : cause.toString(), cause);

  }

  /**
   * Construct a new exception with the specified detail message and cause.
   * 
   * @param message
   *          The detail message
   * @param cause
   *          The underlying cause
   */
  public LogConfigurationException(String message, Throwable cause) {
    super(message + " (Caused by " + cause + ")");
    this.cause = cause; // Two-argument version requires JDK 1.4 or later
  }

  /**
   * The underlying cause of this exception.
   */
  protected Throwable cause = null;

  /**
   * Return the underlying cause of this exception (if any).
   */
  public Throwable getCause() {
    return (this.cause);
  }

}