org.apache.commons.lang.NullArgumentException Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-lang Show documentation
Show all versions of commons-lang Show documentation
Commons.Lang, a package of Java utility classes for the
classes that are in java.lang's hierarchy, or are considered to be so
standard as to justify existence in java.lang.
/*
* 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;
/**
* Thrown to indicate that an argument was null
and should
* not have been.
* This exception supplements the standard IllegalArgumentException
* by providing a more semantically rich description of the problem.
*
* NullArgumentException
represents the case where a method takes
* in a parameter that must not be null
.
* Some coding standards would use NullPointerException
for this case,
* others will use IllegalArgumentException
.
* Thus this exception would be used in place of
* IllegalArgumentException
, yet it still extends it.
*
*
* public void foo(String str) {
* if (str == null) {
* throw new NullArgumentException("str");
* }
* // do something with the string
* }
*
*
* @author Matthew Hawthorne
* @author Stephen Colebourne
* @since 2.0
* @version $Id: NullArgumentException.java 161243 2005-04-14 04:30:28Z ggregory $
*/
public class NullArgumentException extends IllegalArgumentException {
/**
* Instantiates with the given argument name.
*
* @param argName the name of the argument that was null
.
*/
public NullArgumentException(String argName) {
super((argName == null ? "Argument" : argName) + " must not be null.");
}
}