org.apache.commons.math3.exception.MathIllegalNumberException Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-math3 Show documentation
Show all versions of commons-math3 Show documentation
The Apache Commons Math project is a library of lightweight, self-contained mathematics and statistics components addressing the most common practical problems not immediately available in the Java programming language or commons-lang.
/*
* 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.Localizable;
/**
* Base class for exceptions raised by a wrong number.
* This class is not intended to be instantiated directly: it should serve
* as a base class to create all the exceptions that are raised because some
* precondition is violated by a number argument.
*
* @since 2.2
*/
public class MathIllegalNumberException extends MathIllegalArgumentException {
/** Helper to avoid boxing warnings. @since 3.3 */
protected static final Integer INTEGER_ZERO = Integer.valueOf(0);
/** Serializable version Id. */
private static final long serialVersionUID = -7447085893598031110L;
/** Requested. */
private final Number argument;
/**
* Construct an exception.
*
* @param pattern Localizable pattern.
* @param wrong Wrong number.
* @param arguments Arguments.
*/
protected MathIllegalNumberException(Localizable pattern,
Number wrong,
Object ... arguments) {
super(pattern, wrong, arguments);
argument = wrong;
}
/**
* @return the requested value.
*/
public Number getArgument() {
return argument;
}
}