    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     */
    017    package org.apache.commons.math3.exception;
    018
    019    import org.apache.commons.math3.exception.util.Localizable;
    020    import 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     * @version $Id: NumberIsTooLargeException.java 1364378 2012-07-22 17:42:38Z tn $
    027     */
    028    public class NumberIsTooLargeException extends MathIllegalNumberException {
    029        /** Serializable version Id. */
    030        private static final long serialVersionUID = 4330003017885151975L;
    031        /**
    032         * Higher bound.
    033         */
    034        private final Number max;
    035        /**
    036         * Whether the maximum is included in the allowed range.
    037         */
    038        private final boolean boundIsAllowed;
    039
    040        /**
    041         * Construct the exception.
    042         *
    043         * @param wrong Value that is larger than the maximum.
    044         * @param max Maximum.
    045         * @param boundIsAllowed if true the maximum is included in the allowed range.
    046         */
    047        public NumberIsTooLargeException(Number wrong,
    048                                         Number max,
    049                                         boolean boundIsAllowed) {
    050            this(boundIsAllowed ?
    051                 LocalizedFormats.NUMBER_TOO_LARGE :
    052                 LocalizedFormats.NUMBER_TOO_LARGE_BOUND_EXCLUDED,
    053                 wrong, max, boundIsAllowed);
    054        }
    055        /**
    056         * Construct the exception with a specific context.
    057         *
    058         * @param specific Specific context pattern.
    059         * @param wrong Value that is larger than the maximum.
    060         * @param max Maximum.
    061         * @param boundIsAllowed if true the maximum is included in the allowed range.
    062         */
    063        public NumberIsTooLargeException(Localizable specific,
    064                                         Number wrong,
    065                                         Number max,
    066                                         boolean boundIsAllowed) {
    067            super(specific, wrong, max);
    068
    069            this.max = max;
    070            this.boundIsAllowed = boundIsAllowed;
    071        }
    072
    073        /**
    074         * @return {@code true} if the maximum is included in the allowed range.
    075         */
    076        public boolean getBoundIsAllowed() {
    077            return boundIsAllowed;
    078        }
    079
    080        /**
    081         * @return the maximum.
    082         */
    083        public Number getMax() {
    084            return max;
    085        }
    086    }