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.Localizable;
20  import org.apache.commons.math3.exception.util.LocalizedFormats;
21  
22  /**
23   * Exception to be thrown when a number is too large.
24   *
25   * @since 2.2
26   */
27  public class NumberIsTooLargeException extends MathIllegalNumberException {
28      /** Serializable version Id. */
29      private static final long serialVersionUID = 4330003017885151975L;
30      /**
31       * Higher bound.
32       */
33      private final Number max;
34      /**
35       * Whether the maximum is included in the allowed range.
36       */
37      private final boolean boundIsAllowed;
38  
39      /**
40       * Construct the exception.
41       *
42       * @param wrong Value that is larger than the maximum.
43       * @param max Maximum.
44       * @param boundIsAllowed if true the maximum is included in the allowed range.
45       */
46      public NumberIsTooLargeException(Number wrong,
47                                       Number max,
48                                       boolean boundIsAllowed) {
49          this(boundIsAllowed ?
50               LocalizedFormats.NUMBER_TOO_LARGE :
51               LocalizedFormats.NUMBER_TOO_LARGE_BOUND_EXCLUDED,
52               wrong, max, boundIsAllowed);
53      }
54      /**
55       * Construct the exception with a specific context.
56       *
57       * @param specific Specific context pattern.
58       * @param wrong Value that is larger than the maximum.
59       * @param max Maximum.
60       * @param boundIsAllowed if true the maximum is included in the allowed range.
61       */
62      public NumberIsTooLargeException(Localizable specific,
63                                       Number wrong,
64                                       Number max,
65                                       boolean boundIsAllowed) {
66          super(specific, wrong, max);
67  
68          this.max = max;
69          this.boundIsAllowed = boundIsAllowed;
70      }
71  
72      /**
73       * @return {@code true} if the maximum is included in the allowed range.
74       */
75      public boolean getBoundIsAllowed() {
76          return boundIsAllowed;
77      }
78  
79      /**
80       * @return the maximum.
81       */
82      public Number getMax() {
83          return max;
84      }
85  }