net.markenwerk.utils.json.parser.JsonState Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of utils-json-parser Show documentation
A fast event based JSON parser for Java
There is a newer version: 3.0.1
/*
 * Copyright (c) 2016 Torsten Krause, Markenwerk GmbH
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package net.markenwerk.utils.json.parser;

/**
 * A {@link JsonState} describes the current state of a {@link JsonPullParser}
 * and determines which methods may be called successfully next.
 *
 * @author Torsten Krause (tk at markenwerk dot net)
 * @since 1.0.0
 */
public enum JsonState {

	/**
	 * The {@link JsonPullParser} has encountered the begin of a JSON document.
	 * It is possible to {@link JsonPullParser#beginArray() begin} an array or
	 * {@link JsonPullParser#skipValue() skip} the array.
	 */
	DOCUMENT_BEGIN,

	/**
	 * The {@link JsonPullParser} has encountered the end of a JSON document. It
	 * is possible to {@link JsonPullParser#endDocument() end} the document.
	 */
	DOCUMENT_END,

	/**
	 * The {@link JsonPullParser} has encountered the begin of a JSON array. It
	 * is possible to {@link JsonPullParser#beginArray() begin} an array or
	 * {@link JsonPullParser#skipValue() skip} the array.
	 */
	ARRAY_BEGIN,

	/**
	 * The {@link JsonPullParser} has encountered the end of a JSON array. It is
	 * possible to {@link JsonPullParser#endArray() end} the array.
	 */
	ARRAY_END,

	/**
	 * The {@link JsonPullParser} has encountered the begin of a JSON object. It
	 * is possible to {@link JsonPullParser#beginObject() begin} an object or
	 * {@link JsonPullParser#skipValue() skip} the object.
	 */
	OBJECT_BEGIN,

	/**
	 * The {@link JsonPullParser} has encountered the name of a JSON object
	 * element. It is possible to {@link JsonPullParser#nextName() obtain} the
	 * name or {@link JsonPullParser#skipValue() skip} the name and the
	 * corresponding value.
	 */
	NAME,

	/**
	 * The {@link JsonPullParser} has encountered the end of a JSON object. It
	 * is possible to {@link JsonPullParser#endObject() end} the object.
	 */
	OBJECT_END,

	/**
	 * The {@link JsonPullParser} has encountered a JSON null. It is possible to
	 * {@link JsonPullParser#nextNull() obtain} the value or
	 * {@link JsonPullParser#skipValue() skip} the value.
	 */
	NULL,

	/**
	 * The {@link JsonPullParser} has encountered a JSON boolean. It is possible
	 * to {@link JsonPullParser#nextBoolean() obtain} the value or
	 * {@link JsonPullParser#skipValue() skip} the value.
	 */
	BOOLEAN,

	/**
	 * The {@link JsonPullParser} has encountered a JSON integer. It is possible
	 * to obtain the value as a {@link JsonPullParser#nextLong() long},
	 * {@link JsonPullParser#nextInteger() int},
	 * {@link JsonPullParser#nextShort() short},
	 * {@link JsonPullParser#nextCharacter() char},
	 * {@link JsonPullParser#nextByte() byte} or
	 * {@link JsonPullParser#skipValue() skip} the value.
	 */
	LONG,

	/**
	 * The {@link JsonPullParser} has encountered a JSON real. It is possible to
	 * obtain the value as a {@link JsonPullParser#nextDouble() double}
	 * , {@link JsonPullParser#nextFloat() float} or
	 * {@link JsonPullParser#skipValue() skip} the value.
	 */
	DOUBLE,

	/**
	 * The {@link JsonPullParser} has encountered a JSON string. It is possible
	 * to {@link JsonPullParser#nextString() obtain} the value or
	 * {@link JsonPullParser#skipValue() skip} the value.
	 */
	STRING,

	/**
	 * The underlying {@link JsonSource} used by the {@link JsonPullParser} has
	 * no more tokens.
	 */
	SOURCE_END;

}