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 small.
024     *
025     * @since 2.2
026     * @version $Revision$ $Date$
027     */
028    public class NumberIsTooSmallException extends MathIllegalNumberException {
029    
030        /** Serializable version Id. */
031        private static final long serialVersionUID = -6100997100383932834L;
032    
033        /**
034         * Higher bound.
035         */
036        private final Number min;
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 smaller than the minimum.
046         * @param min minimum.
047         * @param boundIsAllowed Whether {@code min} is included in the allowed range.
048         */
049        public NumberIsTooSmallException(Number wrong,
050                                         Number min,
051                                         boolean boundIsAllowed) {
052            this(null, wrong, min, boundIsAllowed);
053        }
054    
055        /**
056         * Construct the exception with a specific context.
057         *
058         * @param specific Specific contexte pattern .
059         * @param wrong Value that is smaller than the minimum.
060         * @param min minimum.
061         * @param boundIsAllowed Whether {@code min} is included in the allowed range.
062         */
063        public NumberIsTooSmallException(Localizable specific,
064                                         Number wrong,
065                                         Number min,
066                                         boolean boundIsAllowed) {
067            super(specific,
068                  boundIsAllowed ?
069                  LocalizedFormats.NUMBER_TOO_SMALL :
070                  LocalizedFormats.NUMBER_TOO_SMALL_BOUND_EXCLUDED,
071                  wrong, min);
072    
073            this.min = min;
074            this.boundIsAllowed = boundIsAllowed;
075        }
076    
077        /**
078         * @return {@code true} if the minimum is included in the allowed range.
079         **/
080        public boolean getBoundIsAllowed() {
081            return boundIsAllowed;
082        }
083    
084        /**
085         * @return the minimum.
086         **/
087        public Number getMin() {
088            return min;
089        }
090    }