Thu, 31 Aug 2017 15:18:52 +0800
merge
1 /*
2 * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
26 package com.sun.xml.internal.bind.v2.model.annotation;
28 import com.sun.xml.internal.bind.v2.runtime.Location;
30 /**
31 * {@link Location} that is chained.
32 *
33 * <p>
34 * {@link Locatable} forms a tree structure, where each {@link Locatable}
35 * points back to the upstream {@link Locatable}.
36 * For example, imagine {@link Locatable} X that points to a particular annotation,
37 * whose upstream is {@link Locatable} Y, which points to a particular method
38 * (on which the annotation is put), whose upstream is {@link Locatable} Z,
39 * which points to a particular class (in which the method is defined),
40 * whose upstream is {@link Locatable} W,
41 * which points to another class (which refers to the class Z), and so on.
42 *
43 * <p>
44 * This chain will be turned into a list when we report the error to users.
45 * This allows them to know where the error happened
46 * and why that place became relevant.
47 *
48 * @author Kohsuke Kawaguchi
49 */
50 public interface Locatable {
51 /**
52 * Gets the upstream {@link Location} information.
53 *
54 * @return
55 * can be null.
56 */
57 Locatable getUpstream();
59 /**
60 * Gets the location object that this object points to.
61 *
62 * This operation could be inefficient and costly.
63 */
64 Location getLocation();
65 }