/
NullArgumentException.java
56 lines (53 loc) · 1.9 KB
/
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
47
48
49
50
51
52
53
54
55
56
/*
* Copyright 2002-2005 The Apache Software Foundation.
*
* Licensed 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.lang;
/**
* <p>Thrown to indicate that an argument was <code>null</code> and should
* not have been.
* This exception supplements the standard <code>IllegalArgumentException</code>
* by providing a more semantically rich description of the problem.</p>
*
* <p><code>NullArgumentException</code> represents the case where a method takes
* in a parameter that must not be <code>null</code>.
* Some coding standards would use <code>NullPointerException</code> for this case,
* others will use <code>IllegalArgumentException</code>.
* Thus this exception would be used in place of
* <code>IllegalArgumentException</code>, yet it still extends it.</p>
*
* <pre>
* public void foo(String str) {
* if (str == null) {
* throw new NullArgumentException("str");
* }
* // do something with the string
* }
* </pre>
*
* @author Matthew Hawthorne
* @author Stephen Colebourne
* @since 2.0
* @version $Id$
*/
public class NullArgumentException extends IllegalArgumentException {
/**
* <p>Instantiates with the given argument name.</p>
*
* @param argName the name of the argument that was <code>null</code>.
*/
public NullArgumentException(String argName) {
super((argName == null ? "Argument" : argName) + " must not be null.");
}
}