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.math3.exception; 018 019 import org.apache.commons.math3.exception.util.LocalizedFormats; 020 import org.apache.commons.math3.exception.util.Localizable; 021 022 /** 023 * Exception to be thrown when some argument is out of range. 024 * 025 * @since 2.2 026 * @version $Id: OutOfRangeException.java 1364378 2012-07-22 17:42:38Z tn $ 027 */ 028 public class OutOfRangeException extends MathIllegalNumberException { 029 /** Serializable version Id. */ 030 private static final long serialVersionUID = 111601815794403609L; 031 /** Lower bound. */ 032 private final Number lo; 033 /** Higher bound. */ 034 private final Number hi; 035 036 /** 037 * Construct an exception from the mismatched dimensions. 038 * 039 * @param wrong Requested value. 040 * @param lo Lower bound. 041 * @param hi Higher bound. 042 */ 043 public OutOfRangeException(Number wrong, 044 Number lo, 045 Number hi) { 046 this(LocalizedFormats.OUT_OF_RANGE_SIMPLE, wrong, lo, hi); 047 } 048 049 /** 050 * Construct an exception from the mismatched dimensions with a 051 * specific context information. 052 * 053 * @param specific Context information. 054 * @param wrong Requested value. 055 * @param lo Lower bound. 056 * @param hi Higher bound. 057 */ 058 public OutOfRangeException(Localizable specific, 059 Number wrong, 060 Number lo, 061 Number hi) { 062 super(specific, wrong, lo, hi); 063 this.lo = lo; 064 this.hi = hi; 065 } 066 067 /** 068 * @return the lower bound. 069 */ 070 public Number getLo() { 071 return lo; 072 } 073 /** 074 * @return the higher bound. 075 */ 076 public Number getHi() { 077 return hi; 078 } 079 }