org.glassfish.jaxb.core.Locatable Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package org.glassfish.jaxb.core;
import org.glassfish.jaxb.core.annotation.XmlLocation;
import org.xml.sax.Locator;
/**
* Optional interface implemented by JAXB objects to expose
* location information from which an object is unmarshalled.
*
*
* This is used during JAXB RI 1.0.x.
* In JAXB 2.0, use {@link XmlLocation}.
*
* @author
* Kohsuke Kawaguchi ([email protected])
*
* @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();
}