src/share/jaxws_classes/com/sun/xml/internal/bind/v2/model/annotation/Locatable.java

changeset 0
373ffda63c9a
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/jaxws_classes/com/sun/xml/internal/bind/v2/model/annotation/Locatable.java	Wed Apr 27 01:27:09 2016 +0800
     1.3 @@ -0,0 +1,65 @@
     1.4 +/*
     1.5 + * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +
    1.29 +package com.sun.xml.internal.bind.v2.model.annotation;
    1.30 +
    1.31 +import com.sun.xml.internal.bind.v2.runtime.Location;
    1.32 +
    1.33 +/**
    1.34 + * {@link Location} that is chained.
    1.35 + *
    1.36 + * <p>
    1.37 + * {@link Locatable} forms a tree structure, where each {@link Locatable}
    1.38 + * points back to the upstream {@link Locatable}.
    1.39 + * For example, imagine {@link Locatable} X that points to a particular annotation,
    1.40 + * whose upstream is {@link Locatable} Y, which points to a particular method
    1.41 + * (on which the annotation is put), whose upstream is {@link Locatable} Z,
    1.42 + * which points to a particular class (in which the method is defined),
    1.43 + * whose upstream is {@link Locatable} W,
    1.44 + * which points to another class (which refers to the class Z), and so on.
    1.45 + *
    1.46 + * <p>
    1.47 + * This chain will be turned into a list when we report the error to users.
    1.48 + * This allows them to know where the error happened
    1.49 + * and why that place became relevant.
    1.50 + *
    1.51 + * @author Kohsuke Kawaguchi
    1.52 + */
    1.53 +public interface Locatable {
    1.54 +    /**
    1.55 +     * Gets the upstream {@link Location} information.
    1.56 +     *
    1.57 +     * @return
    1.58 +     *      can be null.
    1.59 +     */
    1.60 +    Locatable getUpstream();
    1.61 +
    1.62 +    /**
    1.63 +     * Gets the location object that this object points to.
    1.64 +     *
    1.65 +     * This operation could be inefficient and costly.
    1.66 +     */
    1.67 +    Location getLocation();
    1.68 +}

mercurial