1 /*
   2  * Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package java.lang;
  27 
  28 /**
  29  * Thrown when an application tries to access an enum constant by name
  30  * and the enum type contains no constant with the specified name.
  31  * This exception can be thrown by the {@linkplain
  32  * java.lang.reflect.AnnotatedElement API used to read annotations
  33  * reflectively}.
  34  *
  35  * @author  Josh Bloch
  36  * @see     java.lang.reflect.AnnotatedElement
  37  * @since   1.5
  38  */
  39 @SuppressWarnings("rawtypes") /* rawtypes are part of the public api */
  40 public class EnumConstantNotPresentException extends RuntimeException {
  41     private static final long serialVersionUID = -6046998521960521108L;
  42 
  43     /**
  44      * The type of the missing enum constant.
  45      */
  46     private Class<? extends Enum> enumType;
  47 
  48     /**
  49      * The name of the missing enum constant.
  50      */
  51     private String constantName;
  52 
  53     /**
  54      * Constructs an {@code EnumConstantNotPresentException} for the
  55      * specified constant.
  56      *
  57      * @param enumType the type of the missing enum constant
  58      * @param constantName the name of the missing enum constant
  59      */
  60     public EnumConstantNotPresentException(Class<? extends Enum> enumType,
  61                                            String constantName) {
  62         super(enumType.getName() + "." + constantName);
  63         this.enumType = enumType;
  64         this.constantName  = constantName;
  65     }
  66 
  67     /**
  68      * Returns the type of the missing enum constant.
  69      *
  70      * @return the type of the missing enum constant
  71      */
  72     public Class<? extends Enum> enumType() { return enumType; }
  73 
  74     /**
  75      * Returns the name of the missing enum constant.
  76      *
  77      * @return the name of the missing enum constant
  78      */
  79     public String constantName() { return constantName; }
  80 }