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 */
17 package org.apache.commons.math4.legacy.exception;
18
19 import org.apache.commons.math4.legacy.exception.util.ExceptionContext;
20 import org.apache.commons.math4.legacy.exception.util.ExceptionContextProvider;
21 import org.apache.commons.math4.legacy.exception.util.Localizable;
22 import org.apache.commons.math4.legacy.exception.util.LocalizedFormats;
23
24 /**
25 * All conditions checks that fail due to a {@code null} argument must throw
26 * this exception.
27 * This class is meant to signal a precondition violation ("null is an illegal
28 * argument") and so does not extend the standard {@code NullPointerException}.
29 * Propagation of {@code NullPointerException} from within Commons-Math is
30 * construed to be a bug.
31 * <p>
32 * Note: from 4.0 onwards, this class extends {@link NullPointerException} instead
33 * of {@link MathIllegalArgumentException}.
34 *
35 * @since 2.2
36 */
37 public class NullArgumentException extends NullPointerException
38 implements ExceptionContextProvider {
39
40 /** Serializable version Id. */
41 private static final long serialVersionUID = 20150225L;
42
43 /** Context. */
44 private final ExceptionContext context;
45
46 /**
47 * Default constructor.
48 */
49 public NullArgumentException() {
50 this(LocalizedFormats.NULL_NOT_ALLOWED);
51 }
52 /**
53 * @param pattern Message pattern providing the specific context of
54 * the error.
55 * @param arguments Values for replacing the placeholders in {@code pattern}.
56 */
57 public NullArgumentException(Localizable pattern,
58 Object... arguments) {
59 context = new ExceptionContext(this);
60 context.addMessage(pattern, arguments);
61 }
62
63 /**
64 * {@inheritDoc}
65 * @since 4.0
66 */
67 @Override
68 public ExceptionContext getContext() {
69 return context;
70 }
71
72 /** {@inheritDoc} */
73 @Override
74 public String getMessage() {
75 return context.getMessage();
76 }
77
78 /** {@inheritDoc} */
79 @Override
80 public String getLocalizedMessage() {
81 return context.getLocalizedMessage();
82 }
83
84 /**
85 * Checks that an object is not null.
86 *
87 * @param o Object to be checked.
88 * @param pattern Message pattern.
89 * @param args Arguments to replace the placeholders in {@code pattern}.
90 * @throws NullArgumentException if {@code o} is {@code null}.
91 */
92 public static void check(Object o,
93 Localizable pattern,
94 Object... args) {
95 if (o == null) {
96 throw new NullArgumentException(pattern, args);
97 }
98 }
99
100 /**
101 * Checks that an object is not null.
102 *
103 * @param o Object to be checked.
104 * @throws NullArgumentException if {@code o} is {@code null}.
105 */
106 public static void check(Object o) {
107 if (o == null) {
108 throw new NullArgumentException();
109 }
110 }
111 }