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 */
017package org.apache.commons.math3.exception;
018
019import org.apache.commons.math3.exception.util.Localizable;
020import org.apache.commons.math3.exception.util.LocalizedFormats;
021
022/**
023 * Exception to be thrown when some counter maximum value is exceeded.
024 *
025 * @since 3.0
026 */
027public class MaxCountExceededException extends MathIllegalStateException {
028    /** Serializable version Id. */
029    private static final long serialVersionUID = 4330003017885151975L;
030    /**
031     * Maximum number of evaluations.
032     */
033    private final Number max;
034
035    /**
036     * Construct the exception.
037     *
038     * @param max Maximum.
039     */
040    public MaxCountExceededException(Number max) {
041        this(LocalizedFormats.MAX_COUNT_EXCEEDED, max);
042    }
043    /**
044     * Construct the exception with a specific context.
045     *
046     * @param specific Specific context pattern.
047     * @param max Maximum.
048     * @param args Additional arguments.
049     */
050    public MaxCountExceededException(Localizable specific,
051                                     Number max,
052                                     Object ... args) {
053        getContext().addMessage(specific, max, args);
054        this.max = max;
055    }
056
057    /**
058     * @return the maximum number of evaluations.
059     */
060    public Number getMax() {
061        return max;
062    }
063}