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
18 package org.apache.commons.math;
19
20 import org.apache.commons.math.ConvergenceException;
21
22 /**
23 * Error thrown when a numerical computation exceeds its allowed
24 * number of iterations.
25 *
26 * @version $Revision: 746578 $ $Date: 2009-02-21 15:01:14 -0500 (Sat, 21 Feb 2009) $
27 * @since 1.2
28 */
29 public class MaxIterationsExceededException extends ConvergenceException {
30
31 /** Serializable version identifier. */
32 private static final long serialVersionUID = -7821226672760574694L;
33
34 /** Maximal number of iterations allowed. */
35 private final int maxIterations;
36
37 /**
38 * Constructs an exception with specified formatted detail message.
39 * Message formatting is delegated to {@link java.text.MessageFormat}.
40 * @param maxIterations maximal number of iterations allowed
41 */
42 public MaxIterationsExceededException(final int maxIterations) {
43 super("Maximal number of iterations ({0}) exceeded", maxIterations);
44 this.maxIterations = maxIterations;
45 }
46
47 /**
48 * Constructs an exception with specified formatted detail message.
49 * Message formatting is delegated to {@link java.text.MessageFormat}.
50 * @param maxIterations the exceeded maximal number of iterations
51 * @param pattern format specifier
52 * @param arguments format arguments
53 */
54 public MaxIterationsExceededException(final int maxIterations,
55 final String pattern, final Object ... arguments) {
56 super(pattern, arguments);
57 this.maxIterations = maxIterations;
58 }
59
60 /** Get the maximal number of iterations allowed.
61 * @return maximal number of iterations allowed
62 */
63 public int getMaxIterations() {
64 return maxIterations;
65 }
66
67 }