001/* EnumConstantNotPresentException.java -- thrown when enum constant
002   not available
003   Copyright (C) 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
039
040package java.lang;
041
042/**
043 * An exception of this type is thrown when a symbolic reference is
044 * made to an enum constant which does not exist.
045 *
046 * @author Tom Tromey (tromey@redhat.com)
047 * @since 1.5
048 */
049public class EnumConstantNotPresentException extends RuntimeException
050{
051  private static final long serialVersionUID = -6046998521960521108L;
052
053  /**
054   * The enum's type.  Note that the name is fixed by the
055   * serialization spec.
056   */
057  private Class<? extends Enum> enumType;
058
059  /**
060   * The name of the missing enum constant.  Note that the name is
061   * fixed by the serialization spec.
062   */
063  private String constantName;
064
065  /**
066   * Create a new EnumConstantNotPresentException with the indicated
067   * enum type and enum constant name.
068   * @param theEnum the enum's class
069   * @param name the name of the missing enum constant
070   */
071  public EnumConstantNotPresentException(Class<? extends Enum> theEnum,
072                                         String name)
073  {
074    super("enum " + theEnum + " is missing the constant " + name);
075    enumType = theEnum;
076    constantName = name;
077  }
078
079  /**
080   * Return the name of the missing constant.
081   * @return the name of the missing constant
082   */
083  public String constantName()
084  {
085    return constantName;
086  }
087
088  /**
089   * Return the enum type which is missing a constant.
090   * @return the enum type which is missing a constant
091   */
092  public Class<? extends Enum> enumType()
093  {
094    return enumType;
095  }
096}