001 /*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 * http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017 package org.apache.commons.math.exception;
018
019 import org.apache.commons.math.exception.util.LocalizedFormats;
020
021 /**
022 * Exception to be thrown when some argument is out of range.
023 *
024 * @since 2.2
025 * @version $Revision$ $Date$
026 */
027 public class OutOfRangeException extends MathIllegalNumberException {
028
029 /** Serializable version Id. */
030 private static final long serialVersionUID = 111601815794403609L;
031
032 /** Lower bound. */
033 private final Number lo;
034 /** Higher bound. */
035 private final Number hi;
036
037 /**
038 * Construct an exception from the mismatched dimensions.
039 *
040 * @param wrong Requested value.
041 * @param lo Lower bound.
042 * @param hi Higher bound.
043 */
044 public OutOfRangeException(Number wrong,
045 Number lo,
046 Number hi) {
047 super(LocalizedFormats.OUT_OF_RANGE_SIMPLE, wrong, lo, hi);
048 this.lo = lo;
049 this.hi = hi;
050 }
051 /**
052 * @return the lower bound.
053 */
054 public Number getLo() {
055 return lo;
056 }
057 /**
058 * @return the higher bound.
059 */
060 public Number getHi() {
061 return hi;
062 }
063 }