org.dominokit.jacksonapt.stream.JsonReader Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2013 Nicolas Morel
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.dominokit.jacksonapt.stream;
/** JsonReader interface. */
public interface JsonReader {
/**
* Configure this parser to be be liberal in what it accepts. By default, this parser is strict
* and only accepts JSON as specified by RFC
* 4627. Setting the parser to lenient causes it to ignore the following syntax errors:
*
*
* - Streams that start with the non-execute prefix,
* ")]}'\n".
* - Streams that include multiple top-level values. With strict parsing, each stream must
* contain exactly one top-level value.
*
- Top-level values of any type. With strict parsing, the top-level value must be an object
* or an array.
*
- Numbers may be {@link java.lang.Double#isNaN() NaNs} or {@link Double#isInfinite()
* infinities}.
*
- End of line comments starting with {@code //} or {@code #} and ending with a newline
* character.
*
- C-style comments starting with {@code /*} and ending with {@code *}{@code /}. Such
* comments may not be nested.
*
- Names that are unquoted or {@code 'single quoted'}.
*
- Strings that are unquoted or {@code 'single quoted'}.
*
- Array elements separated by {@code ;} instead of {@code ,}.
*
- Unnecessary array separators. These are interpreted as if null was the omitted value.
*
- Names and values separated by {@code =} or {@code =>} instead of {@code :}.
*
- Name/value pairs separated by {@code ;} instead of {@code ,}.
*
*
*
*
* @param lenient a boolean.
*/
void setLenient(boolean lenient);
/**
* Consumes the next token from the JSON stream and asserts that it is the beginning of a new
* array.
*/
void beginArray();
/**
* Consumes the next token from the JSON stream and asserts that it is the end of the current
* array.
*/
void endArray();
/**
* Consumes the next token from the JSON stream and asserts that it is the beginning of a new
* object.
*/
void beginObject();
/**
* Consumes the next token from the JSON stream and asserts that it is the end of the current
* object.
*/
void endObject();
/**
* Returns true if the current array or object has another element.
*
* @return a boolean.
*/
boolean hasNext();
/**
* Returns the type of the next token without consuming it.
*
* @return a {@link org.dominokit.jacksonapt.stream.JsonToken} object.
*/
JsonToken peek();
/**
* Returns the next token, a {@link org.dominokit.jacksonapt.stream.JsonToken#NAME property name},
* and consumes it.
*
* @return a {@link java.lang.String} object.
*/
String nextName();
/**
* Returns the {@link org.dominokit.jacksonapt.stream.JsonToken#STRING string} value of the next
* token, consuming it. If the next token is a number, this method will return its string form.
*
* @return a {@link java.lang.String} object.
* @throws java.lang.IllegalStateException if the next token is not a string or if this reader is
* closed.
*/
String nextString();
/**
* Returns the {@link org.dominokit.jacksonapt.stream.JsonToken#BOOLEAN boolean} value of the next
* token, consuming it.
*
* @return a boolean.
* @throws java.lang.IllegalStateException if the next token is not a boolean or if this reader is
* closed.
*/
boolean nextBoolean();
/**
* Consumes the next token from the JSON stream and asserts that it is a literal null.
*
* @throws java.lang.IllegalStateException if the next token is not null or if this reader is
* closed.
*/
void nextNull();
/**
* Returns the {@link org.dominokit.jacksonapt.stream.JsonToken#NUMBER double} value of the next
* token, consuming it. If the next token is a string, this method will attempt to parse it as a
* double using {@link java.lang.Double#parseDouble(String)}.
*
* @return a double.
* @throws java.lang.IllegalStateException if the next token is not a literal value.
* @throws java.lang.NumberFormatException if the next literal value cannot be parsed as a double,
* or is non-finite.
*/
double nextDouble();
/**
* Returns the {@link org.dominokit.jacksonapt.stream.JsonToken#NUMBER long} value of the next
* token, consuming it. If the next token is a string, this method will attempt to parse it as a
* long. If the next token's numeric value cannot be exactly represented by a Java {@code long},
* this method throws.
*
* @return a long.
* @throws java.lang.IllegalStateException if the next token is not a literal value.
* @throws java.lang.NumberFormatException if the next literal value cannot be parsed as a number,
* or exactly represented as a long.
*/
long nextLong();
/**
* Returns the {@link org.dominokit.jacksonapt.stream.JsonToken#NUMBER int} value of the next
* token, consuming it. If the next token is a string, this method will attempt to parse it as an
* int. If the next token's numeric value cannot be exactly represented by a Java {@code int},
* this method throws.
*
* @return a int.
* @throws java.lang.IllegalStateException if the next token is not a literal value.
* @throws java.lang.NumberFormatException if the next literal value cannot be parsed as a number,
* or exactly represented as an int.
*/
int nextInt();
/** Closes this JSON reader and the underlying {@link java.io.Reader}. */
void close();
/**
* Skips the next value recursively. If it is an object or array, all nested elements are skipped.
* This method is intended for use when the JSON token stream contains unrecognized or unhandled
* values.
*/
void skipValue();
/**
* Reads the next value recursively and returns it as a String. If it is an object or array, all
* nested elements are read.
*
* @return a {@link java.lang.String} object.
*/
String nextValue();
/**
* getLineNumber
*
* @return a int.
*/
int getLineNumber();
/**
* getColumnNumber
*
* @return a int.
*/
int getColumnNumber();
/**
* getInput
*
* @return a {@link java.lang.String} object.
*/
String getInput();
/**
* Returns the {@link java.lang.Number} value of the next token, consuming it. This method will
* attempt to return the best matching number. For non-decimal number, if it fits into an int, an
* int is returned, else a long else a {@link java.math.BigInteger}. For decimal number, a double
* is returned. If the next token's numeric value cannot be exactly represented by a Java {@link
* java.lang.Number}, this method throws.
*
* @return a {@link java.lang.Number} object.
* @throws java.lang.IllegalStateException if the next token is not a number.
* @throws java.lang.NumberFormatException if the next value cannot be parsed as a number.
*/
Number nextNumber();
}