libjava/classpath/java/lang/IllegalArgumentException.java

   1 /* IllegalArgumentException.java -- thrown when a method is passed an
   2    illegal or inappropriate argument
   3    Copyright (C) 1998, 1999, 2001, 2002, 2005  Free Software Foundation, Inc.
   4
   5 This file is part of GNU Classpath.
   6
   7 GNU Classpath is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2, or (at your option)
  10 any later version.
  11
  12 GNU Classpath is distributed in the hope that it will be useful, but
  13 WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU Classpath; see the file COPYING.  If not, write to the
  19 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  20 02110-1301 USA.
  21
  22 Linking this library statically or dynamically with other modules is
  23 making a combined work based on this library.  Thus, the terms and
  24 conditions of the GNU General Public License cover the whole
  25 combination.
  26
  27 As a special exception, the copyright holders of this library give you
  28 permission to link this library with independent modules to produce an
  29 executable, regardless of the license terms of these independent
  30 modules, and to copy and distribute the resulting executable under
  31 terms of your choice, provided that you also meet, for each linked
  32 independent module, the terms and conditions of the license of that
  33 module.  An independent module is a module which is not derived from
  34 or based on this library.  If you modify this library, you may extend
  35 this exception to your version of the library, but you are not
  36 obligated to do so.  If you do not wish to do so, delete this
  37 exception statement from your version. */
  38
  39 package java.lang;
  40
  41 /**
  42  * Thrown when a method is passed an illegal or inappropriate argument. For
  43  * example:<br>
  44  * <pre>
  45  * wait(-1);
  46  * </pre>
  47  *
  48  * @author Brian Jones
  49  * @author Warren Levy (warrenl@cygnus.com)
  50  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  51  * @status updated to 1.5
  52  */
  53 public class IllegalArgumentException extends RuntimeException
  54 {
  55   /**
  56    * Compatible with JDK 1.0+.
  57    */
  58   private static final long serialVersionUID = -5365630128856068164L;
  59
  60   /**
  61    * Create an exception without a message.
  62    */
  63   public IllegalArgumentException()
  64   {
  65   }
  66
  67   /**
  68    * Create an exception with a message.
  69    *
  70    * @param s the message
  71    */
  72   public IllegalArgumentException(String s)
  73   {
  74     super(s);
  75   }
  76
  77   /**
  78    * <p>
  79    * Constructs a <code>IllegalArgumentException</code> using
  80    * the specified error message, which should give further details
  81    * as to the reason for this exception.  The specified cause
  82    * <code>Throwable</code> may be used to provide additional history,
  83    * with regards to the root of the problem.  It is perfectly valid
  84    * for this to be null, if the cause of the problem is unknown.
  85    * </p>
  86    * <p>
  87    * <strong>Note</strong>: the detail message from the cause is not
  88    * automatically incorporated into the resulting detail message of
  89    * this exception.
  90    * </p>
  91    *
  92    * @param message the detail message, which should give the reason for
  93    *                this exception being thrown.
  94    * @param cause the cause of this exception, or null if the cause
  95    *              is unknown.
  96    * @since 1.5
  97    */
  98   public IllegalArgumentException(String message, Throwable cause)
  99   {
 100     super(message, cause);
 101   }
 102
 103   /**
 104    * <p>
 105    * Constructs a <code>IllegalArgumentException</code> using
 106    * the specified cause <code>Throwable</code>, which may be used
 107    * to provide additional history, with regards to the root of the
 108    * problem.  It is perfectly valid for this to be null, if the
 109    * cause of the problem is unknown.
 110    * </p>
 111    * <p>
 112    * The detail message is automatically constructed from the detail
 113    * message of the supplied causal exception.  If the cause is null,
 114    * then the detail message will also be null.  Otherwise, the detail
 115    * message of this exception will be that of the causal exception.
 116    * This makes this constructor very useful for simply wrapping another
 117    * exception.
 118    * </p>
 119    *
 120    * @param cause the cause of this exception, or null if the cause
 121    *              is unknown.
 122    * @since 1.5
 123    */
 124   public IllegalArgumentException(Throwable cause)
 125   {
 126     super(cause);
 127   }
 128
 129 }