org.ojai.util

Class DocumentReaders

java.lang.Object

org.ojai.util.DocumentReaders

public class DocumentReaders
extends Object

Helper class that provides utility methods to work with DocumentReader.

Constructor Summary

Constructors

Constructor and Description
DocumentReaders()

Method Summary

Modifier and Type	Method and Description
static Map<String,Object>	encode(DocumentReader reader) Encodes values from the specified DocumentReader into a Java Map.
static List<Object>	encodeArray(DocumentReader dr) Encodes values from the specified DocumentReader into a Java Map. This method should be called after consuming DocumentReader.EventType.START_ARRAY.
static Map<String,Object>	encodeMap(DocumentReader dr) Encodes values from the specified DocumentReader into a Java List. The difference between this method and encode(DocumentReader) is that this should be called after consuming DocumentReader.EventType.START_MAP.
static Object	encodeValue(DocumentReader dr) Returns the corresponding Java Object for the current node in DocumentReader.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentReaders

public DocumentReaders()

Method Detail

encode

public static Map<String,Object> encode(@API.NonNullable
                                        DocumentReader reader)
                                 throws EncodingException,
                                        TypeException

Encodes values from the specified DocumentReader into a Java Map.

Parameters:

reader -

Returns:

a Map view of the Document

Throws:

EncodingException

TypeException

encodeMap

public static Map<String,Object> encodeMap(DocumentReader dr)
                                    throws EncodingException,
                                           TypeException

Encodes values from the specified DocumentReader into a Java List.

The difference between this method and encode(DocumentReader) is that this should be called after consuming DocumentReader.EventType.START_MAP.

Throws:

EncodingException

TypeException

encodeArray

public static List<Object> encodeArray(DocumentReader dr)
                                throws EncodingException,
                                       TypeException

Encodes values from the specified DocumentReader into a Java Map.

This method should be called after consuming DocumentReader.EventType.START_ARRAY.

Throws:

EncodingException

TypeException

encodeValue

public static Object encodeValue(DocumentReader dr)
                          throws EncodingException,
                                 TypeException

Returns the corresponding Java Object for the current node in DocumentReader.

Throws:

EncodingException

TypeException

See Also:

Value.getObject()