src/main/java/org/apache/commons/math3/exception/NullArgumentException.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

/*
 * 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;
import org.apache.commons.math3.exception.util.LocalizedFormats;

/**
 * All conditions checks that fail due to a {@code null} argument must throw this exception. This
 * class is meant to signal a precondition violation ("null is an illegal argument") and so does not
 * extend the standard {@code NullPointerException}. Propagation of {@code NullPointerException}
 * from within Commons-Math is construed to be a bug.
 *
 * @since 2.2
 */
public class NullArgumentException extends MathIllegalArgumentException {
    /** Serializable version Id. */
    private static final long serialVersionUID = -6024911025449780478L;

    /** Default constructor. */
    public NullArgumentException() {
        this(LocalizedFormats.NULL_NOT_ALLOWED);
    }

    /**
     * @param pattern Message pattern providing the specific context of the error.
     * @param arguments Values for replacing the placeholders in {@code pattern}.
     */
    public NullArgumentException(Localizable pattern, Object... arguments) {
        super(pattern, arguments);
    }
}