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 */
17package org.apache.commons.math.exception;
18
19import org.apache.commons.math.exception.util.Localizable;
20
21/**
22 * Base class for exceptions raised by a wrong number.
23 * This class is not intended to be instantiated directly: it should serve
24 * as a base class to create all the exceptions that are raised because some
25 * precondition is violated by a number argument.
26 *
27 * @since 2.2
28 * @version $Revision$ $Date$
29 */
30public class MathIllegalNumberException extends MathIllegalArgumentException {
31
32    /** Serializable version Id. */
33    private static final long serialVersionUID = -7447085893598031110L;
34
35    /** Requested. */
36    private final Number argument;
37
38    /**
39     * Construct an exception.
40     *
41     * @param specific Localizable pattern.
42     * @param general Localizable pattern.
43     * @param wrong wrong number
44     * @param arguments Arguments.
45     */
46    protected MathIllegalNumberException(Localizable specific,
47                                         Localizable general,
48                                         Number wrong,
49                                         Object ... arguments) {
50        super(specific, general, wrong, arguments);
51        argument = wrong;
52    }
53
54    /**
55     * Construct an exception.
56     *
57     * @param general Localizable pattern.
58     * @param wrong wrong number
59     * @param arguments Arguments.
60     */
61    protected MathIllegalNumberException(Localizable general,
62                                         Number wrong,
63                                         Object ... arguments) {
64        super(general, wrong, arguments);
65        argument = wrong;
66    }
67
68    /**
69     * @return the requested value.
70     */
71    public Number getArgument() {
72        return argument;
73    }
74}
75