001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: package com.sun.xml.bind.v2.runtime;
038:
039: import java.lang.annotation.Annotation;
040: import java.util.ArrayList;
041: import java.util.Collections;
042: import java.util.List;
043:
044: import javax.xml.bind.JAXBContext;
045: import javax.xml.bind.JAXBException;
046:
047: import com.sun.xml.bind.v2.model.annotation.Locatable;
048:
049: /**
050: * Signals an incorrect use of JAXB annotations.
051: *
052: * @author Kohsuke Kawaguchi (kk@kohsuke.org)
053: * @since JAXB 2.0 EA1
054: */
055: public class IllegalAnnotationException extends JAXBException {
056:
057: /**
058: * Read-only list of {@link Location}s.
059: */
060: private final List<List<Location>> pos;
061:
062: private static final long serialVersionUID = 1L;
063:
064: public IllegalAnnotationException(String message, Locatable src) {
065: super (message);
066: pos = build(src);
067: }
068:
069: public IllegalAnnotationException(String message, Annotation src) {
070: this (message, cast(src));
071: }
072:
073: public IllegalAnnotationException(String message, Locatable src1,
074: Locatable src2) {
075: super (message);
076: pos = build(src1, src2);
077: }
078:
079: public IllegalAnnotationException(String message, Annotation src1,
080: Annotation src2) {
081: this (message, cast(src1), cast(src2));
082: }
083:
084: public IllegalAnnotationException(String message, Annotation src1,
085: Locatable src2) {
086: this (message, cast(src1), src2);
087: }
088:
089: public IllegalAnnotationException(String message, Throwable cause,
090: Locatable src) {
091: super (message, cause);
092: pos = build(src);
093: }
094:
095: private static Locatable cast(Annotation a) {
096: if (a instanceof Locatable)
097: return (Locatable) a;
098: else
099: return null;
100: }
101:
102: private List<List<Location>> build(Locatable... srcs) {
103: List<List<Location>> r = new ArrayList<List<Location>>();
104: for (Locatable l : srcs) {
105: if (l != null) {
106: List<Location> ll = convert(l);
107: if (ll != null && !ll.isEmpty())
108: r.add(ll);
109: }
110: }
111: return Collections.unmodifiableList(r);
112: }
113:
114: /**
115: * Builds a list of {@link Location}s out of a {@link Locatable}.
116: */
117: private List<Location> convert(Locatable src) {
118: if (src == null)
119: return null;
120:
121: List<Location> r = new ArrayList<Location>();
122: for (; src != null; src = src.getUpstream())
123: r.add(src.getLocation());
124: return Collections.unmodifiableList(r);
125: }
126:
127: /**
128: * Returns a read-only list of {@link Location} that indicates
129: * where in the source code the problem has happened.
130: *
131: * <p>
132: * Normally, an annotation error happens on one particular
133: * annotation, in which case this method returns a list that
134: * contains another list, which in turn contains the location
135: * information that leads to the error location
136: * (IOW, <tt>[ [pos1,pos2,...,posN] ]</tt>)
137: *
138: * <p>
139: * Sometimes, an error could occur because of two or more conflicting
140: * annotations, in which case this method returns a list
141: * that contains many lists, where each list contains
142: * the location information that leads to each of the conflicting
143: * annotations
144: * (IOW, <tt>[ [pos11,pos12,...,pos1N],[pos21,pos22,...,pos2M], ... ]</tt>)
145: *
146: * <p>
147: * Yet some other time, the runtime can fail to provide any
148: * error location, in which case this method returns an empty list.
149: * (IOW, <tt>[]</tt>). We do try hard to make sure this won't happen,
150: * so please <a href="http://jaxb.dev.java.net/">let us know</a>
151: * if you see this behavior.
152: *
153: *
154: * <h3>List of {@link Location}</h3>
155: * <p>
156: * Each error location is identified not just by one {@link Location}
157: * object, but by a sequence of {@link Location}s that shows why
158: * the runtime is led to the place of the error.
159: * This list is sorted such that the most specific {@link Location} comes
160: * to the first in the list, sort of like a stack trace.
161: *
162: * <p>
163: * For example, suppose you specify class <tt>Foo</tt> to {@link JAXBContext},
164: * <tt>Foo</tt> derives from <tt>Bar</tt>, <tt>Bar</tt> has a field <tt>pea</tt>
165: * that points to <tt>Zot</tt>, <tt>Zot</tt> contains a <tt>gum</tt>
166: * property, and this property has an errornous annotation.
167: * Then when this exception is thrown, the list of {@link Location}s
168: * will look something like
169: * <tt>[ "gum property", "Zot class", "pea property", "Bar class", "Foo class" ]</tt>
170: *
171: *
172: * @return
173: * can be empty when no source position is available,
174: * but never null. The returned list will never contain
175: * null nor length-0 {@link List}.
176: */
177: public List<List<Location>> getSourcePos() {
178: return pos;
179: }
180:
181: /**
182: * Returns the exception name, message, and related information
183: * together in one string.
184: *
185: * <p>
186: * Overriding this method (instead of {@link #printStackTrace} allows
187: * this crucial detail to show up even when this exception is nested
188: * inside other exceptions.
189: */
190: public String toString() {
191: StringBuilder sb = new StringBuilder(getMessage());
192:
193: for (List<Location> locs : pos) {
194: sb
195: .append("\n\tthis problem is related to the following location:");
196: for (Location loc : locs)
197: sb.append("\n\t\tat ").append(loc.toString());
198: }
199:
200: return sb.toString();
201: }
202: }
|