src/main/java/org/apache/commons/math/MaxEvaluationsExceededException.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.commons.math;

import org.apache.commons.math.ConvergenceException;
import org.apache.commons.math.exception.util.DummyLocalizable;
import org.apache.commons.math.exception.util.Localizable;
import org.apache.commons.math.exception.util.LocalizedFormats;

/**
 * Error thrown when a numerical computation exceeds its allowed
 * number of functions evaluations.
 *
 * @version $Revision: 983921 $ $Date: 2010-08-10 12:46:06 +0200 (mar. 10 août 2010) $
 * @since 2.0
 */
public class MaxEvaluationsExceededException extends ConvergenceException {

    /** Serializable version identifier. */
    private static final long serialVersionUID = -5921271447220129118L;

    /** Maximal number of evaluations allowed. */
    private final int maxEvaluations;

    /**
     * Constructs an exception with a default detail message.
     * @param maxEvaluations maximal number of evaluations allowed
     */
    public MaxEvaluationsExceededException(final int maxEvaluations) {
        super(LocalizedFormats.MAX_EVALUATIONS_EXCEEDED, maxEvaluations);
        this.maxEvaluations = maxEvaluations;
    }

    /**
     * Constructs an exception with specified formatted detail message.
     * Message formatting is delegated to {@link java.text.MessageFormat}.
     * @param maxEvaluations the exceeded maximal number of evaluations
     * @param pattern format specifier
     * @param arguments format arguments
     * @deprecated as of 2.2 replaced by {@link #MaxEvaluationsExceededException(int, Localizable, Object...)}
     */
    @Deprecated
    public MaxEvaluationsExceededException(final int maxEvaluations,
                                          final String pattern, final Object ... arguments) {
        this(maxEvaluations, new DummyLocalizable(pattern), arguments);
    }

    /**
     * Constructs an exception with specified formatted detail message.
     * Message formatting is delegated to {@link java.text.MessageFormat}.
     * @param maxEvaluations the exceeded maximal number of evaluations
     * @param pattern format specifier
     * @param arguments format arguments
     * @since 2.2
     */
    public MaxEvaluationsExceededException(final int maxEvaluations,
                                           final Localizable pattern, final Object ... arguments) {
        super(pattern, arguments);
        this.maxEvaluations = maxEvaluations;
    }

    /** Get the maximal number of evaluations allowed.
     * @return maximal number of evaluations allowed
     */
    public int getMaxEvaluations() {
        return maxEvaluations;
    }

}