Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/bind/v2/model/annotation/Locatable.java@e530533619ec (annotated)
src/share/jaxws_classes/com/sun/xml/internal/bind/v2/model/annotation/Locatable.java
Thu, 12 Oct 2017 19:44:07 +0800
- author
- aoqi
- date
- Thu, 12 Oct 2017 19:44:07 +0800
- changeset 760
- e530533619ec
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package com.sun.xml.internal.bind.v2.model.annotation; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import com.sun.xml.internal.bind.v2.runtime.Location; |
| aoqi@0 | 29 | |
| aoqi@0 | 30 | /** |
| aoqi@0 | 31 | * {@link Location} that is chained. |
| aoqi@0 | 32 | * |
| aoqi@0 | 33 | * <p> |
| aoqi@0 | 34 | * {@link Locatable} forms a tree structure, where each {@link Locatable} |
| aoqi@0 | 35 | * points back to the upstream {@link Locatable}. |
| aoqi@0 | 36 | * For example, imagine {@link Locatable} X that points to a particular annotation, |
| aoqi@0 | 37 | * whose upstream is {@link Locatable} Y, which points to a particular method |
| aoqi@0 | 38 | * (on which the annotation is put), whose upstream is {@link Locatable} Z, |
| aoqi@0 | 39 | * which points to a particular class (in which the method is defined), |
| aoqi@0 | 40 | * whose upstream is {@link Locatable} W, |
| aoqi@0 | 41 | * which points to another class (which refers to the class Z), and so on. |
| aoqi@0 | 42 | * |
| aoqi@0 | 43 | * <p> |
| aoqi@0 | 44 | * This chain will be turned into a list when we report the error to users. |
| aoqi@0 | 45 | * This allows them to know where the error happened |
| aoqi@0 | 46 | * and why that place became relevant. |
| aoqi@0 | 47 | * |
| aoqi@0 | 48 | * @author Kohsuke Kawaguchi |
| aoqi@0 | 49 | */ |
| aoqi@0 | 50 | public interface Locatable { |
| aoqi@0 | 51 | /** |
| aoqi@0 | 52 | * Gets the upstream {@link Location} information. |
| aoqi@0 | 53 | * |
| aoqi@0 | 54 | * @return |
| aoqi@0 | 55 | * can be null. |
| aoqi@0 | 56 | */ |
| aoqi@0 | 57 | Locatable getUpstream(); |
| aoqi@0 | 58 | |
| aoqi@0 | 59 | /** |
| aoqi@0 | 60 | * Gets the location object that this object points to. |
| aoqi@0 | 61 | * |
| aoqi@0 | 62 | * This operation could be inefficient and costly. |
| aoqi@0 | 63 | */ |
| aoqi@0 | 64 | Location getLocation(); |
| aoqi@0 | 65 | } |
