Fri, 06 Feb 2009 12:49:48 -0800
6794071: Provide exception superclass for UnknownFooExceptions
Reviewed-by: jjg
duke@1 | 1 | /* |
darcy@216 | 2 | * Copyright 2005-2009 Sun Microsystems, Inc. All Rights Reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
duke@1 | 9 | * by Sun in the LICENSE file that accompanied this code. |
duke@1 | 10 | * |
duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 15 | * accompanied this code). |
duke@1 | 16 | * |
duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 20 | * |
duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
duke@1 | 23 | * have any questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package javax.lang.model.element; |
duke@1 | 27 | |
darcy@216 | 28 | import javax.lang.model.UnknownEntityException; |
darcy@216 | 29 | |
duke@1 | 30 | /** |
duke@1 | 31 | * Indicates that an unknown kind of annotation value was encountered. |
duke@1 | 32 | * This can occur if the language evolves and new kinds of annotation |
duke@1 | 33 | * values can be stored in an annotation. May be thrown by an |
duke@1 | 34 | * {@linkplain AnnotationValueVisitor annotation value visitor} to |
duke@1 | 35 | * indicate that the visitor was created for a prior version of the |
duke@1 | 36 | * language. |
duke@1 | 37 | * |
duke@1 | 38 | * @author Joseph D. Darcy |
duke@1 | 39 | * @author Scott Seligman |
duke@1 | 40 | * @author Peter von der Ahé |
duke@1 | 41 | * @see AnnotationValueVisitor#visitUnknown |
duke@1 | 42 | * @since 1.6 |
duke@1 | 43 | */ |
darcy@216 | 44 | public class UnknownAnnotationValueException extends UnknownEntityException { |
duke@1 | 45 | |
duke@1 | 46 | private static final long serialVersionUID = 269L; |
duke@1 | 47 | |
duke@1 | 48 | private transient AnnotationValue av; |
duke@1 | 49 | private transient Object parameter; |
duke@1 | 50 | |
duke@1 | 51 | /** |
duke@1 | 52 | * Creates a new {@code UnknownAnnotationValueException}. The |
duke@1 | 53 | * {@code p} parameter may be used to pass in an additional |
duke@1 | 54 | * argument with information about the context in which the |
duke@1 | 55 | * unknown annotation value was encountered; for example, the |
duke@1 | 56 | * visit methods of {@link AnnotationValueVisitor} may pass in |
duke@1 | 57 | * their additional parameter. |
duke@1 | 58 | * |
duke@1 | 59 | * @param av the unknown annotation value, may be {@code null} |
duke@1 | 60 | * @param p an additional parameter, may be {@code null} |
duke@1 | 61 | */ |
duke@1 | 62 | public UnknownAnnotationValueException(AnnotationValue av, Object p) { |
duke@1 | 63 | super("Unknown annotation value: " + av); |
duke@1 | 64 | this.av = av; |
duke@1 | 65 | this.parameter = p; |
duke@1 | 66 | } |
duke@1 | 67 | |
duke@1 | 68 | /** |
duke@1 | 69 | * Returns the unknown annotation value. |
duke@1 | 70 | * The value may be unavailable if this exception has been |
duke@1 | 71 | * serialized and then read back in. |
duke@1 | 72 | * |
duke@1 | 73 | * @return the unknown element, or {@code null} if unavailable |
duke@1 | 74 | */ |
duke@1 | 75 | public AnnotationValue getUnknownAnnotationValue() { |
duke@1 | 76 | return av; |
duke@1 | 77 | } |
duke@1 | 78 | |
duke@1 | 79 | /** |
duke@1 | 80 | * Returns the additional argument. |
duke@1 | 81 | * |
duke@1 | 82 | * @return the additional argument |
duke@1 | 83 | */ |
duke@1 | 84 | public Object getArgument() { |
duke@1 | 85 | return parameter; |
duke@1 | 86 | } |
duke@1 | 87 | } |