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