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 */
017package org.apache.commons.math4.exception;
018
019import org.apache.commons.math4.exception.util.Localizable;
020import org.apache.commons.math4.exception.util.LocalizedFormats;
021
022/**
023 * Exception to be thrown when some argument is out of range.
024 *
025 * @since 2.2
026 */
027public class OutOfRangeException extends MathIllegalNumberException {
028    /** Serializable version Id. */
029    private static final long serialVersionUID = 111601815794403609L;
030    /** Lower bound. */
031    private final Number lo;
032    /** Higher bound. */
033    private final Number hi;
034
035    /**
036     * Construct an exception from the mismatched dimensions.
037     *
038     * @param wrong Requested value.
039     * @param lo Lower bound.
040     * @param hi Higher bound.
041     */
042    public OutOfRangeException(Number wrong,
043                               Number lo,
044                               Number hi) {
045        super(LocalizedFormats.OUT_OF_RANGE_SIMPLE, wrong, lo, hi);
046        this.lo = lo;
047        this.hi = hi;
048    }
049
050    /**
051     * Construct an exception from the mismatched dimensions with a
052     * specific context information.
053     *
054     * @param specific Context information.
055     * @param wrong Requested value.
056     * @param lo Lower bound.
057     * @param hi Higher bound.
058     */
059    public OutOfRangeException(Localizable specific,
060                               Number wrong,
061                               Number lo,
062                               Number hi) {
063        this(wrong, lo, hi);
064        getContext().addMessage(specific, wrong, lo, 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}