| /* |
| * 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.math4.exception; |
| |
| import org.apache.commons.math4.exception.util.Localizable; |
| import org.apache.commons.math4.exception.util.LocalizedFormats; |
| |
| /** |
| * Exception to be thrown when a number is too large. |
| * |
| * @since 2.2 |
| */ |
| public class NumberIsTooLargeException extends MathIllegalNumberException { |
| /** Serializable version Id. */ |
| private static final long serialVersionUID = 4330003017885151975L; |
| /** |
| * Higher bound. |
| */ |
| private final Number max; |
| /** |
| * Whether the maximum is included in the allowed range. |
| */ |
| private final boolean boundIsAllowed; |
| |
| /** |
| * Construct the exception. |
| * |
| * @param wrong Value that is larger than the maximum. |
| * @param max Maximum. |
| * @param boundIsAllowed if true the maximum is included in the allowed range. |
| */ |
| public NumberIsTooLargeException(Number wrong, |
| Number max, |
| boolean boundIsAllowed) { |
| this(boundIsAllowed ? |
| LocalizedFormats.NUMBER_TOO_LARGE : |
| LocalizedFormats.NUMBER_TOO_LARGE_BOUND_EXCLUDED, |
| wrong, max, boundIsAllowed); |
| } |
| /** |
| * Construct the exception with a specific context. |
| * |
| * @param specific Specific context pattern. |
| * @param wrong Value that is larger than the maximum. |
| * @param max Maximum. |
| * @param boundIsAllowed if true the maximum is included in the allowed range. |
| */ |
| public NumberIsTooLargeException(Localizable specific, |
| Number wrong, |
| Number max, |
| boolean boundIsAllowed) { |
| super(specific, wrong, max); |
| |
| this.max = max; |
| this.boundIsAllowed = boundIsAllowed; |
| } |
| |
| /** |
| * @return {@code true} if the maximum is included in the allowed range. |
| */ |
| public boolean getBoundIsAllowed() { |
| return boundIsAllowed; |
| } |
| |
| /** |
| * @return the maximum. |
| */ |
| public Number getMax() { |
| return max; |
| } |
| } |