Package org.apache.commons.lang

Class IncompleteArgumentException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
java.lang.IllegalArgumentException
org.apache.commons.lang.IncompleteArgumentException
All Implemented Interfaces:
Serializable
@Deprecated(since="2021-04-30") public class IncompleteArgumentException extends IllegalArgumentException
Deprecated.
Commons Lang 2 is in maintenance mode. Commons Lang 3 should be used instead.

Thrown to indicate an incomplete argument to a method. This exception supplements the standard IllegalArgumentException by providing a more semantically rich description of the problem.

IncompleteArgumentException represents the case where a method takes in a parameter that has a number of properties, some of which have not been set. A case might be a search requirements bean that must have three properties set in order for the method to run, but only one is actually set. This exception would be used in place of IllegalArgumentException, yet it still extends it.

  public void foo(PersonSearcher search) {
    if (search.getSurname() == null ||
        search.getForename() == null ||
        search.getSex() == null) {
      throw new IncompleteArgumentException("search");
    }
    // do something with the searcher
  }
Since:
2.0
See Also:

  • Constructor Details

    • IncompleteArgumentException

      public IncompleteArgumentException(String argName)
      Deprecated.

      Instantiates with the specified description.

      Parameters:
      argName - a description of the incomplete argument

    • IncompleteArgumentException

      public IncompleteArgumentException(String argName, String[] items)
      Deprecated.

      Instantiates with the specified description.

      Parameters:
      argName - a description of the incomplete argument
      items - an array describing the arguments missing