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 aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18751.20241128T090041Z-241100

/*
 * 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.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 Apache Software Foundation
 *  @author Matthew Hawthorne
 *  @since 2.0
 *  @version $Id: NullArgumentException.java 905636 2010-02-02 14:03:32Z niallp $
 *
 * @deprecated Commons Lang 2 is in maintenance mode. Commons Lang 3 should be used instead.
 */
@Deprecated(since = "2021-04-30")
public class NullArgumentException extends IllegalArgumentException {

    /**
     * Required for serialization support.
     *
     * @see java.io.Serializable
     */
    private static final long serialVersionUID = 1174360235354917591L;

    /**
     * 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.");
    }
}