Sat, 01 Dec 2007 00:00:00 +0000
Initial load
duke@1 | 1 | /* |
duke@1 | 2 | * Copyright 2005-2006 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 | |
duke@1 | 28 | /** |
duke@1 | 29 | * Indicates that an unknown kind of element was encountered. This |
duke@1 | 30 | * can occur if the language evolves and new kinds of elements are |
duke@1 | 31 | * added to the {@code Element} hierarchy. May be thrown by an |
duke@1 | 32 | * {@linkplain ElementVisitor element visitor} to indicate that the |
duke@1 | 33 | * visitor was created for a prior version of the language. |
duke@1 | 34 | * |
duke@1 | 35 | * @author Joseph D. Darcy |
duke@1 | 36 | * @author Scott Seligman |
duke@1 | 37 | * @author Peter von der Ahé |
duke@1 | 38 | * @see ElementVisitor#visitUnknown |
duke@1 | 39 | * @since 1.6 |
duke@1 | 40 | */ |
duke@1 | 41 | public class UnknownElementException extends RuntimeException { |
duke@1 | 42 | |
duke@1 | 43 | private static final long serialVersionUID = 269L; |
duke@1 | 44 | |
duke@1 | 45 | private transient Element element; |
duke@1 | 46 | private transient Object parameter; |
duke@1 | 47 | |
duke@1 | 48 | /** |
duke@1 | 49 | * Creates a new {@code UnknownElementException}. The {@code p} |
duke@1 | 50 | * parameter may be used to pass in an additional argument with |
duke@1 | 51 | * information about the context in which the unknown element was |
duke@1 | 52 | * encountered; for example, the visit methods of {@link |
duke@1 | 53 | * ElementVisitor} may pass in their additional parameter. |
duke@1 | 54 | * |
duke@1 | 55 | * @param e the unknown element, may be {@code null} |
duke@1 | 56 | * @param p an additional parameter, may be {@code null} |
duke@1 | 57 | */ |
duke@1 | 58 | public UnknownElementException(Element e, Object p) { |
duke@1 | 59 | super("Unknown element: " + e); |
duke@1 | 60 | element = e; |
duke@1 | 61 | this.parameter = p; |
duke@1 | 62 | } |
duke@1 | 63 | |
duke@1 | 64 | /** |
duke@1 | 65 | * Returns the unknown element. |
duke@1 | 66 | * The value may be unavailable if this exception has been |
duke@1 | 67 | * serialized and then read back in. |
duke@1 | 68 | * |
duke@1 | 69 | * @return the unknown element, or {@code null} if unavailable |
duke@1 | 70 | */ |
duke@1 | 71 | public Element getUnknownElement() { |
duke@1 | 72 | return element; |
duke@1 | 73 | } |
duke@1 | 74 | |
duke@1 | 75 | /** |
duke@1 | 76 | * Returns the additional argument. |
duke@1 | 77 | * |
duke@1 | 78 | * @return the additional argument |
duke@1 | 79 | */ |
duke@1 | 80 | public Object getArgument() { |
duke@1 | 81 | return parameter; |
duke@1 | 82 | } |
duke@1 | 83 | } |