01: /*
02: * Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * 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: */
25:
26: package javax.lang.model.element;
27:
28: /**
29: * Indicates that an unknown kind of element was encountered. This
30: * can occur if the language evolves and new kinds of elements are
31: * added to the {@code Element} hierarchy. May be thrown by an
32: * {@linkplain ElementVisitor element visitor} to indicate that the
33: * visitor was created for a prior version of the language.
34: *
35: * @author Joseph D. Darcy
36: * @author Scott Seligman
37: * @author Peter von der Ahé
38: * @version 1.9 07/05/05
39: * @see ElementVisitor#visitUnknown
40: * @since 1.6
41: */
42: public class UnknownElementException extends RuntimeException {
43:
44: private static final long serialVersionUID = 269L;
45:
46: private transient Element element;
47: private transient Object parameter;
48:
49: /**
50: * Creates a new {@code UnknownElementException}. The {@code p}
51: * parameter may be used to pass in an additional argument with
52: * information about the context in which the unknown element was
53: * encountered; for example, the visit methods of {@link
54: * ElementVisitor} may pass in their additional parameter.
55: *
56: * @param e the unknown element, may be {@code null}
57: * @param p an additional parameter, may be {@code null}
58: */
59: public UnknownElementException(Element e, Object p) {
60: super ("Unknown element: " + e);
61: element = e;
62: this .parameter = p;
63: }
64:
65: /**
66: * Returns the unknown element.
67: * The value may be unavailable if this exception has been
68: * serialized and then read back in.
69: *
70: * @return the unknown element, or {@code null} if unavailable
71: */
72: public Element getUnknownElement() {
73: return element;
74: }
75:
76: /**
77: * Returns the additional argument.
78: *
79: * @return the additional argument
80: */
81: public Object getArgument() {
82: return parameter;
83: }
84: }
|