Home | History | Annotate | Download | only in exception
      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.math.exception;
     18 
     19 import org.apache.commons.math.exception.util.Localizable;
     20 import org.apache.commons.math.exception.util.LocalizedFormats;
     21 
     22 /**
     23  * All conditions checks that fail due to a {@code null} argument must throw
     24  * this exception.
     25  * This class is meant to signal a precondition violation ("null is an illegal
     26  * argument") and so does not extend the standard {@code NullPointerException}.
     27  * Proagation of {@code NullPointerException} from within Commons-Math is
     28  * construed to be a bug.
     29  *
     30  * @since 2.2
     31  * @version $Revision$ $Date$
     32  */
     33 public class NullArgumentException extends MathIllegalArgumentException {
     34     /** Serializable version Id. */
     35     private static final long serialVersionUID = -6024911025449780478L;
     36 
     37     /**
     38      * Default constructor.
     39      */
     40     public NullArgumentException() {
     41         super(LocalizedFormats.NULL_NOT_ALLOWED);
     42     }
     43     /**
     44      * @param specific Message pattern providing the specific context of
     45      * the error.
     46      */
     47     public NullArgumentException(Localizable specific) {
     48         super(specific, LocalizedFormats.NULL_NOT_ALLOWED);
     49     }
     50 }
     51