Source for java.lang.EnumConstantNotPresentException

   1: /* EnumConstantNotPresentException.java -- thrown when enum constant
   2:    not available
   3:    Copyright (C) 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:  * An exception of this type is thrown when a symbolic reference is
  44:  * made to an enum constant which does not exist.
  45:  *
  46:  * @author Tom Tromey (tromey@redhat.com)
  47:  * @since 1.5
  48:  */
  49: public class EnumConstantNotPresentException extends RuntimeException
  50: {
  51:   private static final long serialVersionUID = -6046998521960521108L;
  52: 
  53:   /**
  54:    * The enum's type.  Note that the name is fixed by the
  55:    * serialization spec.
  56:    */
  57:   private Class<? extends Enum> enumType;
  58: 
  59:   /**
  60:    * The name of the missing enum constant.  Note that the name is
  61:    * fixed by the serialization spec.
  62:    */
  63:   private String constantName;
  64: 
  65:   /**
  66:    * Create a new EnumConstantNotPresentException with the indicated
  67:    * enum type and enum constant name.
  68:    * @param theEnum the enum's class
  69:    * @param name the name of the missing enum constant
  70:    */
  71:   public EnumConstantNotPresentException(Class<? extends Enum> theEnum,
  72:                      String name)
  73:   {
  74:     super("enum " + theEnum + " is missing the constant " + name);
  75:     enumType = theEnum;
  76:     constantName = name;
  77:   }
  78: 
  79:   /**
  80:    * Return the name of the missing constant.
  81:    * @return the name of the missing constant
  82:    */
  83:   public String constantName()
  84:   {
  85:     return constantName;
  86:   }
  87: 
  88:   /**
  89:    * Return the enum type which is missing a constant.
  90:    * @return the enum type which is missing a constant
  91:    */
  92:   public Class<? extends Enum> enumType()
  93:   {
  94:     return enumType;
  95:   }
  96: }