1 /* 2 * Copyright (c) 1998, 2005 Gargoyle Software Inc. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are met: 6 * 7 * 1. Redistributions of source code must retain the above copyright notice, 8 * this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright notice, 10 * this list of conditions and the following disclaimer in the documentation 11 * and/or other materials provided with the distribution. 12 * 3. The end-user documentation included with the redistribution, if any, must 13 * include the following acknowledgment: 14 * 15 * "This product includes software developed by Gargoyle Software Inc. 16 * (http://www.GargoyleSoftware.com/)." 17 * 18 * Alternately, this acknowledgment may appear in the software itself, if 19 * and wherever such third-party acknowledgments normally appear. 20 * 4. The name "Gargoyle Software" must not be used to endorse or promote 21 * products derived from this software without prior written permission. 22 * For written permission, please contact info@GargoyleSoftware.com. 23 * 5. Products derived from this software may not be called "GSBase", nor may 24 * "GSBase" appear in their name, without prior written permission of 25 * Gargoyle Software Inc. 26 * 27 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, 28 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 29 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE 30 * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 31 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 32 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 33 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 34 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 35 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 36 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 37 */ 38 package com.gargoylesoftware.base.util; 39 40 41 /*** 42 * A more detailed version of NullPointerException that contains 43 * information about what argument was null. 44 * 45 * @version $Revision: 1.5 $ 46 * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a> 47 */ 48 public class DetailedNullPointerException extends NullPointerException { 49 private static final long serialVersionUID = -2554279092032000569L; 50 private final String argumentName_; 51 52 53 /*** 54 * Create an instance 55 * 56 * @param argumentName The name of the argument that was null 57 * @param message The message to use in the exception 58 */ 59 public DetailedNullPointerException( final String argumentName, final String message ) { 60 61 super(message); 62 argumentName_ = argumentName; 63 } 64 65 66 /*** 67 * Create an instance 68 * 69 * @param argumentName The name of the argument that was null 70 */ 71 public DetailedNullPointerException( final String argumentName ) { 72 this( argumentName, argumentName ); 73 } 74 75 76 /*** 77 * Return the name of the argument that was null. 78 * @return The name of the argument 79 */ 80 public String getArgumentName() { 81 return argumentName_; 82 } 83 } 84