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.math4.legacy.exception;
18
19 import org.apache.commons.math4.legacy.exception.util.Localizable;
20 import org.apache.commons.math4.legacy.exception.util.LocalizedFormats;
21
22 /**
23 * Exception to be thrown when some argument is out of range.
24 *
25 * @since 2.2
26 */
27 public class OutOfRangeException extends MathIllegalNumberException {
28 /** Serializable version Id. */
29 private static final long serialVersionUID = 111601815794403609L;
30 /** Lower bound. */
31 private final Number lo;
32 /** Higher bound. */
33 private final Number hi;
34
35 /**
36 * Construct an exception from the mismatched dimensions.
37 *
38 * @param wrong Requested value.
39 * @param lo Lower bound.
40 * @param hi Higher bound.
41 */
42 public OutOfRangeException(Number wrong,
43 Number lo,
44 Number hi) {
45 super(LocalizedFormats.OUT_OF_RANGE_SIMPLE, wrong, lo, hi);
46 this.lo = lo;
47 this.hi = hi;
48 }
49
50 /**
51 * Construct an exception from the mismatched dimensions with a
52 * specific context information.
53 *
54 * @param specific Context information.
55 * @param wrong Requested value.
56 * @param lo Lower bound.
57 * @param hi Higher bound.
58 */
59 public OutOfRangeException(Localizable specific,
60 Number wrong,
61 Number lo,
62 Number hi) {
63 this(wrong, lo, hi);
64 getContext().addMessage(specific, wrong, lo, 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 }