// Copyright 2011 Google 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 com.google.enterprise.connector.spi;

/**
 * Thrown for general {@link DocumentAcceptor} errors, such as connectivity
 * problems.
 *
 * @since 3.0
 */
public class DocumentAcceptorException extends Exception {
  /**
   * Constructs a new DocumentAcceptorException with no message and no root
   * cause.
   */
  public DocumentAcceptorException() {
    super();
  }

  /**
   * Constructs a DocumentAcceptorException with a supplied message but no root
   * cause.
   *
   * @param message the message. Can be retrieved by the {@link #getMessage()}
   *        method.
   */
  public DocumentAcceptorException(String message) {
    super(message);
  }

  /**
   * Constructs a DocumentAcceptorException with message and root cause.
   *
   * @param message the message. Can be retrieved by the {@link #getMessage()}
   *        method.
   * @param rootCause root failure cause
   */
  public DocumentAcceptorException(String message, Throwable rootCause) {
    super(message, rootCause);
  }

  /**
   * Constructs a DocumentAcceptorException with the specified root cause.
   *
   * @param rootCause root failure cause
   */
  public DocumentAcceptorException(Throwable rootCause) {
    // The cause.toString is normally copied as the message, but we
    // override getMessage differently.
    super(null, rootCause);
  }

  /**
   * Returns the detail message, including messages from nested exceptions
   * if any.
   *
   * @return the message
   */
  @Override
  public String getMessage() {
    String s = super.getMessage();
    Throwable rootCause = getCause();
    if (rootCause == null) {
      return s;
    } else {
      String s2 = rootCause.getMessage();
      return s == null ? s2 : s + ": " + s2;
    }
  }
}