Home | History | Annotate | Download | only in optimization 
      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.optimization;
     19 
     20 import org.apache.commons.math.ConvergenceException;
     21 import org.apache.commons.math.exception.util.DummyLocalizable;
     22 import org.apache.commons.math.exception.util.Localizable;
     23 
     24 /**
     25  * This class represents exceptions thrown by optimizers.
     26  *
     27  * @version $Revision: 1044015 $ $Date: 2010-12-09 17:06:26 +0100 (jeu. 09 dc. 2010) $
     28  * @since 1.2
     29  * @deprecated in 2.2 (to be removed in 3.0).
     30  */
     31 
     32 public class OptimizationException extends ConvergenceException {
     33 
     34     /** Serializable version identifier. */
     35     private static final long serialVersionUID = -4605887730798282127L;
     36 
     37     /**
     38      * Simple constructor.
     39      * Build an exception by translating and formating a message
     40      * @param specifier format specifier (to be translated)
     41      * @param parts to insert in the format (no translation)
     42      * @deprecated as of 2.2 replaced by {@link #OptimizationException(Localizable, Object...)}
     43      */
     44     @Deprecated
     45     public OptimizationException(String specifier, Object ... parts) {
     46         this(new DummyLocalizable(specifier), parts);
     47     }
     48 
     49     /**
     50      * Simple constructor.
     51      * Build an exception by translating and formating a message
     52      * @param specifier format specifier (to be translated)
     53      * @param parts to insert in the format (no translation)
     54      * @since 2.2
     55      */
     56     public OptimizationException(Localizable specifier, Object ... parts) {
     57         super(specifier, parts);
     58     }
     59 
     60     /**
     61      * Create an exception with a given root cause.
     62      * @param cause  the exception or error that caused this exception to be thrown
     63      */
     64     public OptimizationException(Throwable cause) {
     65         super(cause);
     66     }
     67 
     68 }
     69