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 * https://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
18 /*
19 * This is not the original file distributed by the Apache Software Foundation
20 * It has been modified by the Hipparchus project
21 */
22 package org.hipparchus.migration.exception;
23
24 import org.hipparchus.exception.Localizable;
25 import org.hipparchus.migration.exception.util.LocalizedFormats;
26
27 /**
28 * Exception to be thrown when a number is too small.
29 *
30 * @deprecated as of 1.0, this exception is replaced by {@link org.hipparchus.exception.MathIllegalArgumentException}
31 */
32 @Deprecated
33 public class NumberIsTooSmallException extends MathIllegalNumberException {
34 /** Serializable version Id. */
35 private static final long serialVersionUID = -6100997100383932834L;
36 /**
37 * Higher bound.
38 */
39 private final Number min;
40 /**
41 * Whether the maximum is included in the allowed range.
42 */
43 private final boolean boundIsAllowed;
44
45 /**
46 * Construct the exception.
47 *
48 * @param wrong Value that is smaller than the minimum.
49 * @param min Minimum.
50 * @param boundIsAllowed Whether {@code min} is included in the allowed range.
51 */
52 public NumberIsTooSmallException(Number wrong,
53 Number min,
54 boolean boundIsAllowed) {
55 this(boundIsAllowed ?
56 LocalizedFormats.NUMBER_TOO_SMALL :
57 LocalizedFormats.NUMBER_TOO_SMALL_BOUND_EXCLUDED,
58 wrong, min, boundIsAllowed);
59 }
60
61 /**
62 * Construct the exception with a specific context.
63 *
64 * @param specific Specific context pattern.
65 * @param wrong Value that is smaller than the minimum.
66 * @param min Minimum.
67 * @param boundIsAllowed Whether {@code min} is included in the allowed range.
68 */
69 public NumberIsTooSmallException(Localizable specific,
70 Number wrong,
71 Number min,
72 boolean boundIsAllowed) {
73 super(specific, wrong, min);
74
75 this.min = min;
76 this.boundIsAllowed = boundIsAllowed;
77 }
78
79 /** Check if the minimum is included in the allowed range.
80 * @return {@code true} if the minimum is included in the allowed range
81 */
82 public boolean getBoundIsAllowed() { // NOPMD - this method name is for a legacy API we cannot change
83 return boundIsAllowed;
84 }
85
86 /** Get minimum.
87 * @return the minimum
88 */
89 public Number getMin() {
90 return min;
91 }
92 }