org.quartz.exceptions.SchedulerException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sundial Show documentation

A Lightweight Java Job Scheduling Framework

There is a newer version: 2.0.1

/* 
 * Copyright 2001-2009 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.quartz.exceptions;

import org.quartz.Scheduler;

/**
 * Base class for exceptions thrown by the Quartz {@link Scheduler}.
 * 
 * SchedulerExceptions may contain a reference to another Exception, which was the underlying cause of the SchedulerException.
 * 
 * 
 * @author James House
 */
public class SchedulerException extends Exception {

  /*
   * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Constructors. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   */

  public SchedulerException() {

    super();
  }

  public SchedulerException(String msg) {

    super(msg);
  }

  public SchedulerException(Throwable cause) {

    super(cause);
  }

  public SchedulerException(String msg, Throwable cause) {

    super(msg, cause);
  }

  /*
   * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Interface. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   */

  /**
   * 
   * Return the exception that is the underlying cause of this exception.
   * 
   * 
   * This may be used to find more detail about the cause of the error.
   * 
   * 
   * @return the underlying exception, or null if there is not one.
   */
  public Throwable getUnderlyingException() {

    return super.getCause();
  }

  public String toString() {

    Throwable cause = getUnderlyingException();
    if (cause == null || cause == this) {
      return super.toString();
    } else {
      return super.toString() + " [See nested exception: " + cause + "]";
    }
  }

}