aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.bind.v2.model.annotation;
aoqi@0: 
aoqi@0: import com.sun.xml.internal.bind.v2.runtime.Location;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * {@link Location} that is chained.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * {@link Locatable} forms a tree structure, where each {@link Locatable}
aoqi@0:  * points back to the upstream {@link Locatable}.
aoqi@0:  * For example, imagine {@link Locatable} X that points to a particular annotation,
aoqi@0:  * whose upstream is {@link Locatable} Y, which points to a particular method
aoqi@0:  * (on which the annotation is put), whose upstream is {@link Locatable} Z,
aoqi@0:  * which points to a particular class (in which the method is defined),
aoqi@0:  * whose upstream is {@link Locatable} W,
aoqi@0:  * which points to another class (which refers to the class Z), and so on.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * This chain will be turned into a list when we report the error to users.
aoqi@0:  * This allows them to know where the error happened
aoqi@0:  * and why that place became relevant.
aoqi@0:  *
aoqi@0:  * @author Kohsuke Kawaguchi
aoqi@0:  */
aoqi@0: public interface Locatable {
aoqi@0:     /**
aoqi@0:      * Gets the upstream {@link Location} information.
aoqi@0:      *
aoqi@0:      * @return
aoqi@0:      *      can be null.
aoqi@0:      */
aoqi@0:     Locatable getUpstream();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gets the location object that this object points to.
aoqi@0:      *
aoqi@0:      * This operation could be inefficient and costly.
aoqi@0:      */
aoqi@0:     Location getLocation();
aoqi@0: }