javax.json.stream.JsonLocation Maven / Gradle / Ivy
Show all versions of javax.json-api Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2013-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.json.stream;
/**
* Provides the location information of a JSON event in an input source. The
* {@code JsonLocation} information can be used to identify incorrect JSON
* or can be used by higher frameworks to know about the processing location.
*
* All the information provided by a {@code JsonLocation} is optional. For
* example, a provider may only report line numbers. Also, there may not be any
* location information for an input source. For example, if a
* {@code JsonParser} is created using
* {@link javax.json.JsonArray JsonArray} input source, all the methods in
* this class return -1.
* @see JsonParser
* @see JsonParsingException
*/
public interface JsonLocation {
/**
* Return the line number (starts with 1 for the first line) for the current JSON event in the input source.
*
* @return the line number (starts with 1 for the first line) or -1 if none is available
*/
long getLineNumber();
/**
* Return the column number (starts with 1 for the first column) for the current JSON event in the input source.
*
* @return the column number (starts with 1 for the first column) or -1 if none is available
*/
long getColumnNumber();
/**
* Return the stream offset into the input source this location
* is pointing to. If the input source is a file or a byte stream then
* this is the byte offset into that stream, but if the input source is
* a character media then the offset is the character offset.
* Returns -1 if there is no offset available.
*
* @return the offset of input source stream, or -1 if there is
* no offset available
*/
long getStreamOffset();
}