Home | History | Annotate | Download | only in events 
      1 /*
      2  * Licensed to the Apache Software Foundation (ASF) under one or more
      3  * contributor license agreements.  See the NOTICE file distributed with
      4  * this work for additional information regarding copyright ownership.
      5  * The ASF licenses this file to You under the Apache License, Version 2.0
      6  * (the "License"); you may not use this file except in compliance with
      7  * the License.  You may obtain a copy of the License at
      8  *
      9  *      http://www.apache.org/licenses/LICENSE-2.0
     10  *
     11  * Unless required by applicable law or agreed to in writing, software
     12  * distributed under the License is distributed on an "AS IS" BASIS,
     13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     14  * See the License for the specific language governing permissions and
     15  * limitations under the License.
     16  */
     17 
     18 package org.apache.commons.math.ode.events;
     19 
     20 import org.apache.commons.math.MathException;
     21 import org.apache.commons.math.exception.util.Localizable;
     22 
     23 /**
     24  * This exception is made available to users to report
     25  * the error conditions that are triggered by {@link EventHandler}
     26  * @version $Revision: 983921 $ $Date: 2010-08-10 12:46:06 +0200 (mar. 10 aot 2010) $
     27  * @since 2.0
     28  */
     29 public class EventException extends MathException {
     30 
     31     /** Serialization UID. */
     32     private static final long serialVersionUID = -898215297400035290L;
     33 
     34     /** Simple constructor.
     35      * Build an exception by translating and formating a message
     36      * @param specifier format specifier (to be translated)
     37      * @param parts to insert in the format (no translation)
     38      * @deprecated as of 2.2 replaced by {@link #EventException(Localizable, Object...)}
     39      */
     40      @Deprecated
     41     public EventException(final String specifier, final Object ... parts) {
     42         super(specifier, parts);
     43     }
     44 
     45     /** Simple constructor.
     46      * Build an exception by translating and formating a message
     47      * @param specifier format specifier (to be translated)
     48      * @param parts to insert in the format (no translation)
     49      * @since 2.2
     50      */
     51     public EventException(final Localizable specifier, final Object ... parts) {
     52         super(specifier, parts);
     53     }
     54 
     55     /**
     56      * Create an exception with a given root cause.
     57      * @param cause  the exception or error that caused this exception to be thrown
     58      */
     59     public EventException(final Throwable cause) {
     60         super(cause);
     61     }
     62 
     63 }
     64