001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.math3.exception;
018
019import org.apache.commons.math3.exception.util.Localizable;
020import org.apache.commons.math3.exception.util.LocalizedFormats;
021
022/**
023 * Exception to be thrown when a number is too large.
024 *
025 * @since 2.2
026 */
027public class NumberIsTooLargeException extends MathIllegalNumberException {
028    /** Serializable version Id. */
029    private static final long serialVersionUID = 4330003017885151975L;
030    /**
031     * Higher bound.
032     */
033    private final Number max;
034    /**
035     * Whether the maximum is included in the allowed range.
036     */
037    private final boolean boundIsAllowed;
038
039    /**
040     * Construct the exception.
041     *
042     * @param wrong Value that is larger than the maximum.
043     * @param max Maximum.
044     * @param boundIsAllowed if true the maximum is included in the allowed range.
045     */
046    public NumberIsTooLargeException(Number wrong,
047                                     Number max,
048                                     boolean boundIsAllowed) {
049        this(boundIsAllowed ?
050             LocalizedFormats.NUMBER_TOO_LARGE :
051             LocalizedFormats.NUMBER_TOO_LARGE_BOUND_EXCLUDED,
052             wrong, max, boundIsAllowed);
053    }
054    /**
055     * Construct the exception with a specific context.
056     *
057     * @param specific Specific context pattern.
058     * @param wrong Value that is larger than the maximum.
059     * @param max Maximum.
060     * @param boundIsAllowed if true the maximum is included in the allowed range.
061     */
062    public NumberIsTooLargeException(Localizable specific,
063                                     Number wrong,
064                                     Number max,
065                                     boolean boundIsAllowed) {
066        super(specific, wrong, max);
067
068        this.max = max;
069        this.boundIsAllowed = boundIsAllowed;
070    }
071
072    /**
073     * @return {@code true} if the maximum is included in the allowed range.
074     */
075    public boolean getBoundIsAllowed() {
076        return boundIsAllowed;
077    }
078
079    /**
080     * @return the maximum.
081     */
082    public Number getMax() {
083        return max;
084    }
085}