blob: f9f80e6175ac0944439c5d63dfc9978606edf1ce [file] [log] [blame]
/*
* Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.xml.internal.bind;
import com.sun.xml.internal.bind.annotation.XmlLocation;
import org.xml.sax.Locator;
/**
* Optional interface implemented by JAXB objects to expose
* location information from which an object is unmarshalled.
*
* <p>
* This is used during JAXB RI 1.0.x.
* In JAXB 2.0, use {@link XmlLocation}.
*
* @author
* Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
*
* @since JAXB RI 1.0
*/
public interface Locatable {
/**
* @return
* null if the location information is unavaiable,
* or otherwise return a immutable valid {@link Locator}
* object.
*/
Locator sourceLocation();
}