summaryrefslogtreecommitdiff
path: root/src/main/java/org/apache/commons/math3/exception/MaxCountExceededException.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/org/apache/commons/math3/exception/MaxCountExceededException.java')
-rw-r--r--src/main/java/org/apache/commons/math3/exception/MaxCountExceededException.java61
1 files changed, 61 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/math3/exception/MaxCountExceededException.java b/src/main/java/org/apache/commons/math3/exception/MaxCountExceededException.java
new file mode 100644
index 0000000..bc97c84
--- /dev/null
+++ b/src/main/java/org/apache/commons/math3/exception/MaxCountExceededException.java
@@ -0,0 +1,61 @@
+/*
+ * 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.math3.exception;
+
+import org.apache.commons.math3.exception.util.Localizable;
+import org.apache.commons.math3.exception.util.LocalizedFormats;
+
+/**
+ * Exception to be thrown when some counter maximum value is exceeded.
+ *
+ * @since 3.0
+ */
+public class MaxCountExceededException extends MathIllegalStateException {
+ /** Serializable version Id. */
+ private static final long serialVersionUID = 4330003017885151975L;
+
+ /** Maximum number of evaluations. */
+ private final Number max;
+
+ /**
+ * Construct the exception.
+ *
+ * @param max Maximum.
+ */
+ public MaxCountExceededException(Number max) {
+ this(LocalizedFormats.MAX_COUNT_EXCEEDED, max);
+ }
+
+ /**
+ * Construct the exception with a specific context.
+ *
+ * @param specific Specific context pattern.
+ * @param max Maximum.
+ * @param args Additional arguments.
+ */
+ public MaxCountExceededException(Localizable specific, Number max, Object... args) {
+ getContext().addMessage(specific, max, args);
+ this.max = max;
+ }
+
+ /**
+ * @return the maximum number of evaluations.
+ */
+ public Number getMax() {
+ return max;
+ }
+}