1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
/*
* 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 iterations.
*
* @version $Revision: 1070725 $ $Date: 2011-02-15 02:31:12 +0100 (mar. 15 févr. 2011) $
* @since 1.2
*/
public class MaxIterationsExceededException extends ConvergenceException {
/** Serializable version identifier. */
private static final long serialVersionUID = -7821226672760574694L;
/** Maximal number of iterations allowed. */
private final int maxIterations;
/**
* Constructs an exception with a default detail message.
* @param maxIterations maximal number of iterations allowed
*/
public MaxIterationsExceededException(final int maxIterations) {
super(LocalizedFormats.MAX_ITERATIONS_EXCEEDED, maxIterations);
this.maxIterations = maxIterations;
}
/**
* Constructs an exception with specified formatted detail message.
* Message formatting is delegated to {@link java.text.MessageFormat}.
* @param maxIterations the exceeded maximal number of iterations
* @param pattern format specifier
* @param arguments format arguments
* @deprecated as of 2.2 replaced by {@link #MaxIterationsExceededException(int, Localizable, Object...)}
*/
@Deprecated
public MaxIterationsExceededException(final int maxIterations,
final String pattern, final Object ... arguments) {
this(maxIterations, new DummyLocalizable(pattern), arguments);
}
/**
* Constructs an exception with specified formatted detail message.
* Message formatting is delegated to {@link java.text.MessageFormat}.
* @param maxIterations the exceeded maximal number of iterations
* @param pattern format specifier
* @param arguments format arguments
* @since 2.2
*/
public MaxIterationsExceededException(final int maxIterations,
final Localizable pattern, final Object ... arguments) {
super(pattern, arguments);
this.maxIterations = maxIterations;
}
/** Get the maximal number of iterations allowed.
* @return maximal number of iterations allowed
*/
public int getMaxIterations() {
return maxIterations;
}
}
|