org.kurento.commons.exception.KurentoException Maven / Gradle / Ivy

Go to download
/*
 * (C) Copyright 2013 Kurento (http://kurento.org/)
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the GNU Lesser General Public License
 * (LGPL) version 2.1 which accompanies this distribution, and is available at
 * http://www.gnu.org/licenses/lgpl-2.1.html
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 */

package org.kurento.commons.exception;

/**
 * 
 * It's usage is intended for system-level exceptions. Usage is encouraged in the following cases:
 * 

 * If the method encounters a system exception or error, but never for business related errors.
 * 
If the method performs an operation that results in a checked exception that the bean method
 * cannot recover.
 * 
Any other unexpected error conditions.
 * 
 * 
 * The original exception cause must be provided within the exception if it is raised due to a
 * previous exception.
 * 
 * This kind of exceptions are not checked and with CMT provoke a roll back at the moment the are
 * thrown.
 *
 * @author Ivan Gracia ([email protected])
 * @since 4.1.1
 */
public class KurentoException extends RuntimeException {

  private static final long serialVersionUID = 2319005818919493142L;

  /**
   * default constructor.
   */
  public KurentoException() {
    // Default constructor
  }

  /**
   * Constructs a new runtime exception with the specified detail message. The cause is not
   * initialized, and may subsequently be initialized by a call to initCause.
   *
   * @param msg
   *          the detail message. The detail message is saved for later retrieval by the
   *          {@link #getMessage()} method.
   */
  public KurentoException(final String msg) {
    super(msg);
  }

  /**
   *
   * @param msg
   *          the detail message. The detail message is saved for later retrieval by the
   *          {@link #getMessage()} method.
   * @param throwable
   *          the cause (which is saved for later retrieval by the {@link #getCause()} method). (A
   *          null value is permitted, and indicates that the cause is nonexistent or unknown.)
   */
  public KurentoException(final String msg, final Throwable throwable) {
    super(msg, throwable);
  }

  /**
   *
   * @param throwable
   *          the cause (which is saved for later retrieval by the {@link #getCause()} method). (A
   *          null value is permitted, and indicates that the cause is nonexistent or unknown.)
   */
  public KurentoException(final Throwable throwable) {
    super(throwable);
  }

}