01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.xml.bind.v2.model.annotation;
38:
39: import com.sun.xml.bind.v2.runtime.Location;
40:
41: /**
42: * {@link Location} that is chained.
43: *
44: * <p>
45: * {@link Locatable} forms a tree structure, where each {@link Locatable}
46: * points back to the upstream {@link Locatable}.
47: * For example, imagine {@link Locatable} X that points to a particular annotation,
48: * whose upstream is {@link Locatable} Y, which points to a particular method
49: * (on which the annotation is put), whose upstream is {@link Locatable} Z,
50: * which points to a particular class (in which the method is defined),
51: * whose upstream is {@link Locatable} W,
52: * which points to another class (which refers to the class Z), and so on.
53: *
54: * <p>
55: * This chain will be turned into a list when we report the error to users.
56: * This allows them to know where the error happened
57: * and why that place became relevant.
58: *
59: * @author Kohsuke Kawaguchi
60: */
61: public interface Locatable {
62: /**
63: * Gets the upstream {@link Location} information.
64: *
65: * @return
66: * can be null.
67: */
68: Locatable getUpstream();
69:
70: /**
71: * Gets the location object that this object points to.
72: *
73: * This operation could be inefficient and costly.
74: */
75: Location getLocation();
76: }
|