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.math3.exception;
018
019import org.apache.commons.math3.exception.util.Localizable;
020import org.apache.commons.math3.exception.util.LocalizedFormats;
021
022/**
023 * All conditions checks that fail due to a {@code null} argument must throw
024 * this exception.
025 * This class is meant to signal a precondition violation ("null is an illegal
026 * argument") and so does not extend the standard {@code NullPointerException}.
027 * Propagation of {@code NullPointerException} from within Commons-Math is
028 * construed to be a bug.
029 *
030 * @since 2.2
031 */
032public class NullArgumentException extends MathIllegalArgumentException {
033    /** Serializable version Id. */
034    private static final long serialVersionUID = -6024911025449780478L;
035
036    /**
037     * Default constructor.
038     */
039    public NullArgumentException() {
040        this(LocalizedFormats.NULL_NOT_ALLOWED);
041    }
042    /**
043     * @param pattern Message pattern providing the specific context of
044     * the error.
045     * @param arguments Values for replacing the placeholders in {@code pattern}.
046     */
047    public NullArgumentException(Localizable pattern,
048                                 Object ... arguments) {
049        super(pattern, arguments);
050    }
051}