View Javadoc

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.math3.exception;
18  
19  import org.apache.commons.math3.exception.util.LocalizedFormats;
20  import org.apache.commons.math3.exception.util.Localizable;
21  
22  /**
23   * Exception to be thrown when some argument is out of range.
24   *
25   * @since 2.2
26   * @version $Id: OutOfRangeException.java 1364378 2012-07-22 17:42:38Z tn $
27   */
28  public class OutOfRangeException extends MathIllegalNumberException {
29      /** Serializable version Id. */
30      private static final long serialVersionUID = 111601815794403609L;
31      /** Lower bound. */
32      private final Number lo;
33      /** Higher bound. */
34      private final Number hi;
35  
36      /**
37       * Construct an exception from the mismatched dimensions.
38       *
39       * @param wrong Requested value.
40       * @param lo Lower bound.
41       * @param hi Higher bound.
42       */
43      public OutOfRangeException(Number wrong,
44                                 Number lo,
45                                 Number hi) {
46          this(LocalizedFormats.OUT_OF_RANGE_SIMPLE, wrong, lo, hi);
47      }
48  
49      /**
50       * Construct an exception from the mismatched dimensions with a
51       * specific context information.
52       *
53       * @param specific Context information.
54       * @param wrong Requested value.
55       * @param lo Lower bound.
56       * @param hi Higher bound.
57       */
58      public OutOfRangeException(Localizable specific,
59                                 Number wrong,
60                                 Number lo,
61                                 Number hi) {
62          super(specific, wrong, lo, hi);
63          this.lo = lo;
64          this.hi = hi;
65      }
66  
67      /**
68       * @return the lower bound.
69       */
70      public Number getLo() {
71          return lo;
72      }
73      /**
74       * @return the higher bound.
75       */
76      public Number getHi() {
77          return hi;
78      }
79  }