Home | History | Annotate | Download | only in exception
      1 /*
      2  * Licensed to the Apache Software Foundation (ASF) under one or more
      3  * contributor license agreements.  See the NOTICE file distributed with
      4  * this work for additional information regarding copyright ownership.
      5  * The ASF licenses this file to You under the Apache License, Version 2.0
      6  * (the "License"); you may not use this file except in compliance with
      7  * the License.  You may obtain a copy of the License at
      8  *
      9  *      http://www.apache.org/licenses/LICENSE-2.0
     10  *
     11  * Unless required by applicable law or agreed to in writing, software
     12  * distributed under the License is distributed on an "AS IS" BASIS,
     13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     14  * See the License for the specific language governing permissions and
     15  * limitations under the License.
     16  */
     17 package org.apache.commons.math.exception;
     18 
     19 import org.apache.commons.math.exception.util.LocalizedFormats;
     20 
     21 /**
     22  * Exception to be thrown when some argument is out of range.
     23  *
     24  * @since 2.2
     25  * @version $Revision$ $Date$
     26  */
     27 public class OutOfRangeException extends MathIllegalNumberException {
     28 
     29     /** Serializable version Id. */
     30     private static final long serialVersionUID = 111601815794403609L;
     31 
     32     /** Lower bound. */
     33     private final Number lo;
     34     /** Higher bound. */
     35     private final Number hi;
     36 
     37     /**
     38      * Construct an exception from the mismatched dimensions.
     39      *
     40      * @param wrong Requested value.
     41      * @param lo Lower bound.
     42      * @param hi Higher bound.
     43      */
     44     public OutOfRangeException(Number wrong,
     45                                Number lo,
     46                                Number hi) {
     47         super(LocalizedFormats.OUT_OF_RANGE_SIMPLE, wrong, lo, hi);
     48         this.lo = lo;
     49         this.hi = hi;
     50     }
     51     /**
     52      * @return the lower bound.
     53      */
     54     public Number getLo() {
     55         return lo;
     56     }
     57     /**
     58      * @return the higher bound.
     59      */
     60     public Number getHi() {
     61         return hi;
     62     }
     63 }
     64