    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    package org.apache.commons.math3.exception;
    018
    019    import org.apache.commons.math3.exception.util.Localizable;
    020    import 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     * @version $Id: MaxCountExceededException.java 1364378 2012-07-22 17:42:38Z tn $
    027     */
    028    public class MaxCountExceededException extends MathIllegalStateException {
    029        /** Serializable version Id. */
    030        private static final long serialVersionUID = 4330003017885151975L;
    031        /**
    032         * Maximum number of evaluations.
    033         */
    034        private final Number max;
    035
    036        /**
    037         * Construct the exception.
    038         *
    039         * @param max Maximum.
    040         */
    041        public MaxCountExceededException(Number max) {
    042            this(LocalizedFormats.MAX_COUNT_EXCEEDED, max);
    043        }
    044        /**
    045         * Construct the exception with a specific context.
    046         *
    047         * @param specific Specific context pattern.
    048         * @param max Maximum.
    049         * @param args Additional arguments.
    050         */
    051        public MaxCountExceededException(Localizable specific,
    052                                         Number max,
    053                                         Object ... args) {
    054            getContext().addMessage(specific, max, args);
    055            this.max = max;
    056        }
    057
    058        /**
    059         * @return the maximum number of evaluations.
    060         */
    061        public Number getMax() {
    062            return max;
    063        }
    064    }