001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    
018    package org.apache.commons.math.optimization;
019    
020    import org.apache.commons.math.ConvergenceException;
021    import org.apache.commons.math.exception.util.DummyLocalizable;
022    import org.apache.commons.math.exception.util.Localizable;
023    
024    /**
025     * This class represents exceptions thrown by optimizers.
026     *
027     * @version $Revision: 1044015 $ $Date: 2010-12-09 17:06:26 +0100 (jeu. 09 d??c. 2010) $
028     * @since 1.2
029     * @deprecated in 2.2 (to be removed in 3.0).
030     */
031    
032    public class OptimizationException extends ConvergenceException {
033    
034        /** Serializable version identifier. */
035        private static final long serialVersionUID = -4605887730798282127L;
036    
037        /**
038         * Simple constructor.
039         * Build an exception by translating and formating a message
040         * @param specifier format specifier (to be translated)
041         * @param parts to insert in the format (no translation)
042         * @deprecated as of 2.2 replaced by {@link #OptimizationException(Localizable, Object...)}
043         */
044        @Deprecated
045        public OptimizationException(String specifier, Object ... parts) {
046            this(new DummyLocalizable(specifier), parts);
047        }
048    
049        /**
050         * Simple constructor.
051         * Build an exception by translating and formating a message
052         * @param specifier format specifier (to be translated)
053         * @param parts to insert in the format (no translation)
054         * @since 2.2
055         */
056        public OptimizationException(Localizable specifier, Object ... parts) {
057            super(specifier, parts);
058        }
059    
060        /**
061         * Create an exception with a given root cause.
062         * @param cause  the exception or error that caused this exception to be thrown
063         */
064        public OptimizationException(Throwable cause) {
065            super(cause);
066        }
067    
068    }