src/share/classes/javax/lang/model/element/UnknownAnnotationValueException.java

Fri, 06 Feb 2009 12:49:48 -0800

author
darcy
date
Fri, 06 Feb 2009 12:49:48 -0800
changeset 216
58fcba61a77d
parent 1
9a66ca7c79fa
child 554
9d9f26857129
permissions
-rw-r--r--

6794071: Provide exception superclass for UnknownFooExceptions
Reviewed-by: jjg

     1 /*
     2  * Copyright 2005-2009 Sun Microsystems, Inc.  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.  Sun designates this
     8  * particular file as subject to the "Classpath" exception as provided
     9  * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
    22  * CA 95054 USA or visit www.sun.com if you need additional information or
    23  * have any questions.
    24  */
    26 package javax.lang.model.element;
    28 import javax.lang.model.UnknownEntityException;
    30 /**
    31  * Indicates that an unknown kind of annotation value was encountered.
    32  * This can occur if the language evolves and new kinds of annotation
    33  * values can be stored in an annotation.  May be thrown by an
    34  * {@linkplain AnnotationValueVisitor annotation value visitor} to
    35  * indicate that the visitor was created for a prior version of the
    36  * language.
    37  *
    38  * @author Joseph D. Darcy
    39  * @author Scott Seligman
    40  * @author Peter von der Ahé
    41  * @see AnnotationValueVisitor#visitUnknown
    42  * @since 1.6
    43  */
    44 public class UnknownAnnotationValueException extends UnknownEntityException {
    46     private static final long serialVersionUID = 269L;
    48     private transient AnnotationValue av;
    49     private transient Object parameter;
    51     /**
    52      * Creates a new {@code UnknownAnnotationValueException}.  The
    53      * {@code p} parameter may be used to pass in an additional
    54      * argument with information about the context in which the
    55      * unknown annotation value was encountered; for example, the
    56      * visit methods of {@link AnnotationValueVisitor} may pass in
    57      * their additional parameter.
    58      *
    59      * @param av the unknown annotation value, may be {@code null}
    60      * @param p an additional parameter, may be {@code null}
    61      */
    62     public UnknownAnnotationValueException(AnnotationValue av, Object p) {
    63         super("Unknown annotation value: " + av);
    64         this.av = av;
    65         this.parameter = p;
    66     }
    68     /**
    69      * Returns the unknown annotation value.
    70      * The value may be unavailable if this exception has been
    71      * serialized and then read back in.
    72      *
    73      * @return the unknown element, or {@code null} if unavailable
    74      */
    75     public AnnotationValue getUnknownAnnotationValue() {
    76         return av;
    77     }
    79     /**
    80      * Returns the additional argument.
    81      *
    82      * @return the additional argument
    83      */
    84     public Object getArgument() {
    85         return parameter;
    86     }
    87 }

mercurial