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 package org.apache.commons.math3.exception;
18
19 import org.apache.commons.math3.exception.util.Localizable;
20 import org.apache.commons.math3.exception.util.LocalizedFormats;
21
22 /**
23 * Exception to be thrown when some counter maximum value is exceeded.
24 *
25 * @since 3.0
26 * @version $Id: MaxCountExceededException.java 1364378 2012-07-22 17:42:38Z tn $
27 */
28 public class MaxCountExceededException extends MathIllegalStateException {
29 /** Serializable version Id. */
30 private static final long serialVersionUID = 4330003017885151975L;
31 /**
32 * Maximum number of evaluations.
33 */
34 private final Number max;
35
36 /**
37 * Construct the exception.
38 *
39 * @param max Maximum.
40 */
41 public MaxCountExceededException(Number max) {
42 this(LocalizedFormats.MAX_COUNT_EXCEEDED, max);
43 }
44 /**
45 * Construct the exception with a specific context.
46 *
47 * @param specific Specific context pattern.
48 * @param max Maximum.
49 * @param args Additional arguments.
50 */
51 public MaxCountExceededException(Localizable specific,
52 Number max,
53 Object ... args) {
54 getContext().addMessage(specific, max, args);
55 this.max = max;
56 }
57
58 /**
59 * @return the maximum number of evaluations.
60 */
61 public Number getMax() {
62 return max;
63 }
64 }