    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.math.exception;
    018
    019    import org.apache.commons.math.exception.util.Localizable;
    020    import org.apache.commons.math.exception.util.LocalizedFormats;
    021
    022    /**
    023     * Exception to be thrown when a number is too large.
    024     *
    025     * @since 2.2
    026     * @version $Revision$ $Date$
    027     */
    028    public class NumberIsTooLargeException extends MathIllegalNumberException {
    029
    030        /** Serializable version Id. */
    031        private static final long serialVersionUID = 4330003017885151975L;
    032
    033        /**
    034         * Higher bound.
    035         */
    036        private final Number max;
    037        /**
    038         * Whether the maximum is included in the allowed range.
    039         */
    040        private final boolean boundIsAllowed;
    041
    042        /**
    043         * Construct the exception.
    044         *
    045         * @param wrong Value that is larger than the maximum.
    046         * @param max maximum.
    047         * @param boundIsAllowed if true the maximum is included in the allowed range.
    048         */
    049        public NumberIsTooLargeException(Number wrong,
    050                                         Number max,
    051                                         boolean boundIsAllowed) {
    052            this(null, wrong, max, boundIsAllowed);
    053        }
    054        /**
    055         * Construct the exception with a specific context.
    056         *
    057         * @param specific Specific contexte 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,
    067                  boundIsAllowed ?
    068                  LocalizedFormats.NUMBER_TOO_LARGE :
    069                  LocalizedFormats.NUMBER_TOO_LARGE_BOUND_EXCLUDED,
    070                  wrong, max);
    071
    072            this.max = max;
    073            this.boundIsAllowed = boundIsAllowed;
    074        }
    075
    076        /**
    077         * @return {@code true} if the maximum is included in the allowed range.
    078         **/
    079        public boolean getBoundIsAllowed() {
    080            return boundIsAllowed;
    081        }
    082
    083        /**
    084         * @return the maximum.
    085         **/
    086        public Number getMax() {
    087            return max;
    088        }
    089    }