001/* IllegalArgumentException.java -- thrown when a method is passed an
002   illegal or inappropriate argument
003   Copyright (C) 1998, 1999, 2001, 2002, 2005  Free Software Foundation, Inc.
004
005This file is part of GNU Classpath.
006
007GNU Classpath is free software; you can redistribute it and/or modify
008it under the terms of the GNU General Public License as published by
009the Free Software Foundation; either version 2, or (at your option)
010any later version.
011
012GNU Classpath is distributed in the hope that it will be useful, but
013WITHOUT ANY WARRANTY; without even the implied warranty of
014MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
015General Public License for more details.
016
017You should have received a copy of the GNU General Public License
018along with GNU Classpath; see the file COPYING.  If not, write to the
019Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02002110-1301 USA.
021
022Linking this library statically or dynamically with other modules is
023making a combined work based on this library.  Thus, the terms and
024conditions of the GNU General Public License cover the whole
025combination.
026
027As a special exception, the copyright holders of this library give you
028permission to link this library with independent modules to produce an
029executable, regardless of the license terms of these independent
030modules, and to copy and distribute the resulting executable under
031terms of your choice, provided that you also meet, for each linked
032independent module, the terms and conditions of the license of that
033module.  An independent module is a module which is not derived from
034or based on this library.  If you modify this library, you may extend
035this exception to your version of the library, but you are not
036obligated to do so.  If you do not wish to do so, delete this
037exception statement from your version. */
038
039package java.lang;
040
041/**
042 * Thrown when a method is passed an illegal or inappropriate argument. For
043 * example:<br>
044 * <pre>
045 * wait(-1);
046 * </pre>
047 *
048 * @author Brian Jones
049 * @author Warren Levy (warrenl@cygnus.com)
050 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
051 * @status updated to 1.5
052 */
053public class IllegalArgumentException extends RuntimeException
054{
055  /**
056   * Compatible with JDK 1.0+.
057   */
058  private static final long serialVersionUID = -5365630128856068164L;
059
060  /**
061   * Create an exception without a message.
062   */
063  public IllegalArgumentException()
064  {
065  }
066
067  /**
068   * Create an exception with a message.
069   *
070   * @param s the message
071   */
072  public IllegalArgumentException(String s)
073  {
074    super(s);
075  }
076
077  /**
078   * <p>
079   * Constructs a <code>IllegalArgumentException</code> using
080   * the specified error message, which should give further details
081   * as to the reason for this exception.  The specified cause
082   * <code>Throwable</code> may be used to provide additional history,
083   * with regards to the root of the problem.  It is perfectly valid
084   * for this to be null, if the cause of the problem is unknown.
085   * </p>
086   * <p>
087   * <strong>Note</strong>: the detail message from the cause is not
088   * automatically incorporated into the resulting detail message of
089   * this exception.
090   * </p>
091   *
092   * @param message the detail message, which should give the reason for
093   *                this exception being thrown.
094   * @param cause the cause of this exception, or null if the cause
095   *              is unknown.
096   * @since 1.5
097   */
098  public IllegalArgumentException(String message, Throwable cause)
099  {
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}