com.oracle.javafx.jmx.json

Interface JSONReader

All Superinterfaces:

java.lang.Iterable<JSONReader.EventType>, java.util.Iterator<JSONReader.EventType>

All Known Implementing Classes:

JSONStreamReaderImpl

public interface JSONReader
extends java.lang.Iterable<JSONReader.EventType>, java.util.Iterator<JSONReader.EventType>

Interface for reading a JSON document. An example of how to read a simple JSON document.

 JSON: { "abc": "123" }

 JSONFactory FACTORY = JSONFactory.instance();
 JSONWriter r = FACTORY.makeReader(reader);
 r.next();  // START_DOCUMENT
 r.depth(); // depth = -1
 r.next();  // START_OBJECT
 r.next();  // START_VALUE
 r.key();   // key = "abc"
 r.next();  // STRING
 r.value(); // value = "123"
 r.next();  // END_VALUE
 r.next();  // END_OBJECT
 r.next();  // END_DOCUMENT
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JSONReader.EventType The type of JSON events.

Method Summary

Modifier and Type	Method and Description
JSONDocument	build() Build an in-memory representation of the input JSON.
void	close() Close the underlying Reader when done reading.
int	column() The current column number in the JSON file.
int	depth() The reader's current depth in the JSON file.
java.lang.String	key() The name of the current JSON object.
int	line() The current line number in the JSON file.
JSONReader.EventType	next(java.lang.String key, int depth) Skips until the specified object is found at the specified depth.
long	offset() The current byte offset in the underlying Reader.
java.lang.String[]	path() Returns the path from the root to the current position of the JSON file.
java.lang.String	value() The value of the current JSON object or array element.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Detail

key

java.lang.String key()

The name of the current JSON object.

Returns:

the name of a JSON object.

value

java.lang.String value()

The value of the current JSON object or array element.

Returns:

the value of the JSON object or array element.

next

JSONReader.EventType next(java.lang.String key,
                          int depth)

Skips until the specified object is found at the specified depth. If depth is negative, find the first occurrence of the specified object. If objectName is null, skip until the specified depth is reached.

Parameters:

key - the name of the object to find, may be null

depth - stop at the first element at this depth, ignored if negative

Returns:

the event at which this method stops, EventType.END_DOCUMENT if not found

close

void close()

Close the underlying Reader when done reading.

line

int line()

The current line number in the JSON file.

Returns:

the current line number in the JSON file

column

int column()

The current column number in the JSON file.

Returns:

the current column number in the JSON file.

offset

long offset()

The current byte offset in the underlying Reader. This is useful for computing percent completion.

Returns:

the current byte offset

depth

int depth()

The reader's current depth in the JSON file.

Returns:

the current depth in the JSON file.

path

java.lang.String[] path()

Returns the path from the root to the current position of the JSON file.

Returns:

a String array containing the path.

build

JSONDocument build()

Build an in-memory representation of the input JSON. JSON Objects are represented with Maps and JSON Arrays are represented with Lists.

Returns:

a JSONDocument that contains a Map or a List representing the root of the input object