Source for java.lang.IllegalStateException

   1: /* IllegalStateException.java -- thrown when invoking a method at
   2:    an illegal or inappropriate time
   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: 
  40: package java.lang;
  41: 
  42: /**
  43:  * Thrown when a method is invoked at an illegal or inappropriate time. For
  44:  * example:<br>
  45:  * <pre>
  46:  * void m(Collecion c)
  47:  * {
  48:  *   c.iterator().remove();
  49:  * }
  50:  * </pre>
  51:  *
  52:  * @author Brian Jones
  53:  * @author Warren Levy (warrenl@cygnus.com)
  54:  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  55:  * @since 1.1
  56:  * @status updated to 1.5
  57:  */
  58: public class IllegalStateException extends RuntimeException
  59: {
  60:   /**
  61:    * Compatible with JDK 1.1+.
  62:    */
  63:   private static final long serialVersionUID = -1848914673093119416L;
  64: 
  65:   /**
  66:    * Create an exception without a message.
  67:    */
  68:   public IllegalStateException()
  69:   {
  70:   }
  71: 
  72:   /**
  73:    * Create an exception with a message.
  74:    *
  75:    * @param s the message
  76:    */
  77:   public IllegalStateException(String s)
  78:   {
  79:     super(s);
  80:   }
  81: 
  82:   /**
  83:    * <p>
  84:    * Constructs a <code>IllegalStateException</code> using
  85:    * the specified error message, which should give further details
  86:    * as to the reason for this exception.  The specified cause
  87:    * <code>Throwable</code> may be used to provide additional history,
  88:    * with regards to the root of the problem.  It is perfectly valid
  89:    * for this to be null, if the cause of the problem is unknown.
  90:    * </p>
  91:    * <p>
  92:    * <strong>Note</strong>: the detail message from the cause is not
  93:    * automatically incorporated into the resulting detail message of
  94:    * this exception.
  95:    * </p>
  96:    * 
  97:    * @param message the detail message, which should give the reason for
  98:    *                this exception being thrown.
  99:    * @param cause the cause of this exception, or null if the cause
 100:    *              is unknown.
 101:    * @since 1.5
 102:    */
 103:   public IllegalStateException(String message, Throwable cause)
 104:   {
 105:     super(message, cause);
 106:   }
 107: 
 108:   /**
 109:    * <p>
 110:    * Constructs a <code>IllegalStateException</code> using
 111:    * the specified cause <code>Throwable</code>, which may be used
 112:    * to provide additional history, with regards to the root of the
 113:    * problem.  It is perfectly valid for this to be null, if the
 114:    * cause of the problem is unknown.
 115:    * </p>
 116:    * <p>
 117:    * The detail message is automatically constructed from the detail
 118:    * message of the supplied causal exception.  If the cause is null,
 119:    * then the detail message will also be null.  Otherwise, the detail
 120:    * message of this exception will be that of the causal exception.
 121:    * This makes this constructor very useful for simply wrapping another
 122:    * exception.
 123:    * </p>
 124:    * 
 125:    * @param cause the cause of this exception, or null if the cause
 126:    *              is unknown.
 127:    * @since 1.5
 128:    */
 129:   public IllegalStateException(Throwable cause)
 130:   {
 131:     super(cause);
 132:   }
 133: 
 134: }