/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.math3.exception;

import org.apache.commons.math3.exception.util.LocalizedFormats;
import org.apache.commons.math3.exception.util.Localizable;

Exception to be thrown when some argument is out of range.
Since:2.2
/** * Exception to be thrown when some argument is out of range. * * @since 2.2 */
public class OutOfRangeException extends MathIllegalNumberException {
Serializable version Id.
/** Serializable version Id. */
private static final long serialVersionUID = 111601815794403609L;
Lower bound.
/** Lower bound. */
private final Number lo;
Higher bound.
/** Higher bound. */
private final Number hi;
Construct an exception from the mismatched dimensions.
Params:
  • wrong – Requested value.
  • lo – Lower bound.
  • hi – Higher bound.
/** * Construct an exception from the mismatched dimensions. * * @param wrong Requested value. * @param lo Lower bound. * @param hi Higher bound. */
public OutOfRangeException(Number wrong, Number lo, Number hi) { this(LocalizedFormats.OUT_OF_RANGE_SIMPLE, wrong, lo, hi); }
Construct an exception from the mismatched dimensions with a specific context information.
Params:
  • specific – Context information.
  • wrong – Requested value.
  • lo – Lower bound.
  • hi – Higher bound.
/** * Construct an exception from the mismatched dimensions with a * specific context information. * * @param specific Context information. * @param wrong Requested value. * @param lo Lower bound. * @param hi Higher bound. */
public OutOfRangeException(Localizable specific, Number wrong, Number lo, Number hi) { super(specific, wrong, lo, hi); this.lo = lo; this.hi = hi; }
Returns:the lower bound.
/** * @return the lower bound. */
public Number getLo() { return lo; }
Returns:the higher bound.
/** * @return the higher bound. */
public Number getHi() { return hi; } }