org.ojai.json

Class Json

java.lang.Object

org.ojai.json.Json

@API.Public
 @API.Factory
public final class Json
extends Object

This class serves as a factory for a JSON implementation of all OJAI interfaces.

Constructor Summary

Constructors

Constructor and Description
Json()

Method Summary

Modifier and Type	Method and Description
static <T> T	encode(String jsonString, Class<T> beanClass)
static ValueBuilder	getValueBuilder() Returns a ValueBuilder object.
static Document	loadDocument(File file) Loads a JSON file as OJAI Document.
static Document	loadDocument(String filePath) Loads a JSON file as OJAI Document.
static Document	newDocument() Returns a new, empty Document.
static <T> Document	newDocument(Map<String,T> map) Returns a new instance of a Document built from the specified Map.
static Document	newDocument(Object bean) Returns a new instance of a Document built from the specified Java bean.
static Document	newDocument(String jsonString) Returns a Document built from the specified JSON string.
static DocumentBuilder	newDocumentBuilder() Returns a new instance of JSON DocumentBuilder.
static DocumentBuilder	newDocumentBuilder(JsonOptions options) Returns a new instance of JSON DocumentBuilder with the specified JsonOptions.
static DocumentReader	newDocumentReader(String jsonString) Returns a new instance of the JSON DocumentReader.
static DocumentStream	newDocumentStream(org.apache.hadoop.fs.FileSystem fs, String path)
static DocumentStream	newDocumentStream(org.apache.hadoop.fs.FileSystem fs, String path, Events.Delegate eventDelegate)
static DocumentStream	newDocumentStream(org.apache.hadoop.fs.FileSystem fs, String path, Map<FieldPath,Value.Type> fieldPathTypeMap)
static DocumentStream	newDocumentStream(InputStream in) Returns a new instance of JSON DocumentStream from the specified InputStream.
static DocumentStream	newDocumentStream(InputStream in, Events.Delegate eventDelegate)
static DocumentStream	newDocumentStream(InputStream in, Map<FieldPath,Value.Type> fieldPathTypeMap) Returns a new instance of s JSON DocumentStream from the specified InputStream using the FieldPath => Type mapping to decode the JSON tokens from the stream.
static String	toJsonString(Document d)
static String	toJsonString(Document d, JsonOptions options)
static String	toJsonString(DocumentReader r)
static String	toJsonString(DocumentReader r, JsonOptions options)
static void	writeReaderToBuilder(DocumentReader r, DocumentBuilder w) Deprecated. Use Documents.writeReaderToBuilder(DocumentReader, DocumentBuilder)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Json

public Json()

Method Detail

newDocument

public static Document newDocument()

Returns a new, empty Document.

loadDocument

public static Document loadDocument(String filePath)
                             throws IOException

Loads a JSON file as OJAI Document.

Throws:

IOException

loadDocument

public static Document loadDocument(File file)
                             throws IOException

Loads a JSON file as OJAI Document.

Throws:

IOException

getValueBuilder

public static ValueBuilder getValueBuilder()

Returns a ValueBuilder object.

newDocument

public static Document newDocument(@API.NonNullable
                                   String jsonString)
                            throws DecodingException

Returns a Document built from the specified JSON string.

Throws:

DecodingException

newDocument

public static Document newDocument(@API.NonNullable
                                   Object bean)
                            throws DecodingException

Returns a new instance of a Document built from the specified Java bean.

Throws:

DecodingException

newDocument

public static <T> Document newDocument(@API.NonNullable
                                       Map<String,T> map)
                                throws DecodingException

Returns a new instance of a Document built from the specified Map.

Throws:

DecodingException

newDocumentReader

public static DocumentReader newDocumentReader(@API.NonNullable
                                               String jsonString)
                                        throws DecodingException

Returns a new instance of the JSON DocumentReader.

Throws:

DecodingException

newDocumentBuilder

public static DocumentBuilder newDocumentBuilder()

Returns a new instance of JSON DocumentBuilder.

newDocumentBuilder

public static DocumentBuilder newDocumentBuilder(@API.NonNullable
                                                 JsonOptions options)

Returns a new instance of JSON DocumentBuilder with the specified JsonOptions.

newDocumentStream

public static DocumentStream newDocumentStream(@API.NonNullable
                                               InputStream in)

Returns a new instance of JSON DocumentStream from the specified InputStream.

newDocumentStream

public static DocumentStream newDocumentStream(@API.NonNullable
                                               InputStream in,
                                               @API.NonNullable
                                               Map<FieldPath,Value.Type> fieldPathTypeMap)

Returns a new instance of s JSON DocumentStream from the specified InputStream using the FieldPath => Type mapping to decode the JSON tokens from the stream.

newDocumentStream

public static DocumentStream newDocumentStream(@API.NonNullable
                                               InputStream in,
                                               @API.NonNullable
                                               Events.Delegate eventDelegate)

newDocumentStream

public static DocumentStream newDocumentStream(@API.NonNullable
                                               org.apache.hadoop.fs.FileSystem fs,
                                               @API.NonNullable
                                               String path)
                                        throws DecodingException,
                                               IOException

Throws:

DecodingException

IOException

newDocumentStream

public static DocumentStream newDocumentStream(@API.NonNullable
                                               org.apache.hadoop.fs.FileSystem fs,
                                               @API.NonNullable
                                               String path,
                                               @API.NonNullable
                                               Map<FieldPath,Value.Type> fieldPathTypeMap)
                                        throws DecodingException,
                                               IOException

Throws:

DecodingException

IOException

newDocumentStream

public static DocumentStream newDocumentStream(@API.NonNullable
                                               org.apache.hadoop.fs.FileSystem fs,
                                               @API.NonNullable
                                               String path,
                                               @API.NonNullable
                                               Events.Delegate eventDelegate)
                                        throws DecodingException,
                                               IOException

Throws:

DecodingException

IOException

encode

public static <T> T encode(@API.NonNullable
                           String jsonString,
                           @API.NonNullable
                           Class<T> beanClass)

toJsonString

public static String toJsonString(@API.NonNullable
                                  Document d)

toJsonString

public static String toJsonString(@API.NonNullable
                                  Document d,
                                  @API.NonNullable
                                  JsonOptions options)

toJsonString

public static String toJsonString(@API.NonNullable
                                  DocumentReader r)

toJsonString

public static String toJsonString(@API.NonNullable
                                  DocumentReader r,
                                  @API.NonNullable
                                  JsonOptions options)

writeReaderToBuilder

public static void writeReaderToBuilder(@API.NonNullable
                                        DocumentReader r,
                                        @API.NonNullable
                                        DocumentBuilder w)

Deprecated. Use Documents.writeReaderToBuilder(DocumentReader, DocumentBuilder)