com.dropbox.core.json

Class JsonReader<T>

java.lang.Object

com.dropbox.core.json.JsonReader<T>

Direct Known Subclasses:

DbxDelta.Entry.Reader, DbxDelta.Reader, DbxDeltaC.Entry.Reader, DbxDeltaC.Reader, DbxEntry.WithChildrenC.Reader, DbxEntry.WithChildrenC.ReaderMaybeDeleted, JsonArrayReader

public abstract class JsonReader<T>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonReader.FieldMapping If you're implementing a JsonReader for a JSON object, you can use this to map field names to a number you can switch on to efficiently locate assign a field.
static class	JsonReader.FileLoadException

Field Summary

Fields

Modifier and Type	Field and Description
static JsonReader<byte[]>	BinaryReader
static JsonReader<Boolean>	BooleanReader
static JsonReader<Float>	Float32Reader
static JsonReader<Double>	Float64Reader
static JsonReader<Integer>	Int32Reader
static JsonReader<Long>	Int64Reader
static JsonReader<String>	StringReader
static JsonReader<Long>	UInt32Reader
static JsonReader<Long>	UInt64Reader
static JsonReader<Long>	UnsignedLongReader
static JsonReader<Object>	VoidReader

Constructor Summary

Constructors

Constructor and Description
JsonReader()

Method Summary

Modifier and Type	Method and Description
static com.fasterxml.jackson.core.JsonLocation	expectArrayEnd(com.fasterxml.jackson.core.JsonParser parser)
static com.fasterxml.jackson.core.JsonLocation	expectArrayStart(com.fasterxml.jackson.core.JsonParser parser)
static void	expectObjectEnd(com.fasterxml.jackson.core.JsonParser parser)
static com.fasterxml.jackson.core.JsonLocation	expectObjectStart(com.fasterxml.jackson.core.JsonParser parser)
static boolean	isArrayEnd(com.fasterxml.jackson.core.JsonParser parser)
static boolean	isArrayStart(com.fasterxml.jackson.core.JsonParser parser)
static com.fasterxml.jackson.core.JsonToken	nextToken(com.fasterxml.jackson.core.JsonParser parser) A wrapper around 'JsonParser.nextToken' that throws our own better JsonReadException instead of Jackson's JsonParseException.
abstract T	read(com.fasterxml.jackson.core.JsonParser parser)
static boolean	readBoolean(com.fasterxml.jackson.core.JsonParser parser)
static double	readDouble(com.fasterxml.jackson.core.JsonParser parser)
static <T> T	readEnum(com.fasterxml.jackson.core.JsonParser parser, HashMap<String,T> values, T catch_all)
T	readField(com.fasterxml.jackson.core.JsonParser parser, String fieldName, T v)
T	readFields(com.fasterxml.jackson.core.JsonParser parser)
T	readFromFile(File file)
T	readFromFile(String filePath)
T	readFromTags(String[] tags, com.fasterxml.jackson.core.JsonParser parser)
T	readFully(byte[] utf8Body)
T	readFully(InputStream utf8Body)
T	readFully(com.fasterxml.jackson.core.JsonParser parser)
T	readFully(String body)
T	readOptional(com.fasterxml.jackson.core.JsonParser parser)
static String[]	readTags(com.fasterxml.jackson.core.JsonParser parser) Helper to read and parse the optional ".tag" field.
static long	readUnsignedLong(com.fasterxml.jackson.core.JsonParser parser)
static long	readUnsignedLongField(com.fasterxml.jackson.core.JsonParser parser, String fieldName, long v)
static void	skipValue(com.fasterxml.jackson.core.JsonParser parser)
void	validate(T value)

Methods inherited from class java.lang.Object

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

Field Detail

UnsignedLongReader

public static final JsonReader<Long> UnsignedLongReader

Int64Reader

public static final JsonReader<Long> Int64Reader

Int32Reader

public static final JsonReader<Integer> Int32Reader

UInt64Reader

public static final JsonReader<Long> UInt64Reader

UInt32Reader

public static final JsonReader<Long> UInt32Reader

Float64Reader

public static final JsonReader<Double> Float64Reader

Float32Reader

public static final JsonReader<Float> Float32Reader

StringReader

public static final JsonReader<String> StringReader

BinaryReader

public static final JsonReader<byte[]> BinaryReader

BooleanReader

public static final JsonReader<Boolean> BooleanReader

VoidReader

public static final JsonReader<Object> VoidReader

Constructor Detail

JsonReader

public JsonReader()

Method Detail

read

public abstract T read(com.fasterxml.jackson.core.JsonParser parser)
                throws IOException,
                       JsonReadException

Throws:

IOException

JsonReadException

readFromTags

public T readFromTags(String[] tags,
                      com.fasterxml.jackson.core.JsonParser parser)
               throws IOException,
                      JsonReadException

Throws:

IOException

JsonReadException

readFields

public T readFields(com.fasterxml.jackson.core.JsonParser parser)
             throws IOException,
                    JsonReadException

Throws:

IOException

JsonReadException

validate

public void validate(T value)

readField

public final T readField(com.fasterxml.jackson.core.JsonParser parser,
                         String fieldName,
                         T v)
                  throws IOException,
                         JsonReadException

Throws:

IOException

JsonReadException

readOptional

public final T readOptional(com.fasterxml.jackson.core.JsonParser parser)
                     throws IOException,
                            JsonReadException

Throws:

IOException

JsonReadException

readTags

public static String[] readTags(com.fasterxml.jackson.core.JsonParser parser)
                         throws IOException,
                                JsonReadException

Helper to read and parse the optional ".tag" field. If one is found, positions the parser at the next field (or the closing brace); otherwise leaves the parser position unchanged. Returns null if there isn't a ".tag" field; otherwise an array of strings (the tags). Initially the parser must be positioned right after the opening brace.

Throws:

IOException

JsonReadException

nextToken

public static com.fasterxml.jackson.core.JsonToken nextToken(com.fasterxml.jackson.core.JsonParser parser)
                                                      throws IOException,
                                                             JsonReadException

A wrapper around 'JsonParser.nextToken' that throws our own better JsonReadException instead of Jackson's JsonParseException.

JsonParseException is bad for two reasons. First, it extends IOException, which makes it easy to miss. Second, there's no way to get the original error message, which makes it hard to chain logical location information (see JsonReadException.addFieldContext(java.lang.String) and JsonReadException.addArrayContext(int)).

Throws:

IOException

JsonReadException

expectObjectStart

public static com.fasterxml.jackson.core.JsonLocation expectObjectStart(com.fasterxml.jackson.core.JsonParser parser)
                                                                 throws IOException,
                                                                        JsonReadException

Throws:

IOException

JsonReadException

expectObjectEnd

public static void expectObjectEnd(com.fasterxml.jackson.core.JsonParser parser)
                            throws IOException,
                                   JsonReadException

Throws:

IOException

JsonReadException

expectArrayStart

public static com.fasterxml.jackson.core.JsonLocation expectArrayStart(com.fasterxml.jackson.core.JsonParser parser)
                                                                throws IOException,
                                                                       JsonReadException

Throws:

IOException

JsonReadException

expectArrayEnd

public static com.fasterxml.jackson.core.JsonLocation expectArrayEnd(com.fasterxml.jackson.core.JsonParser parser)
                                                              throws IOException,
                                                                     JsonReadException

Throws:

IOException

JsonReadException

isArrayEnd

public static boolean isArrayEnd(com.fasterxml.jackson.core.JsonParser parser)

isArrayStart

public static boolean isArrayStart(com.fasterxml.jackson.core.JsonParser parser)

skipValue

public static void skipValue(com.fasterxml.jackson.core.JsonParser parser)
                      throws IOException,
                             JsonReadException

Throws:

IOException

JsonReadException

readUnsignedLong

public static long readUnsignedLong(com.fasterxml.jackson.core.JsonParser parser)
                             throws IOException,
                                    JsonReadException

Throws:

IOException

JsonReadException

readUnsignedLongField

public static long readUnsignedLongField(com.fasterxml.jackson.core.JsonParser parser,
                                         String fieldName,
                                         long v)
                                  throws IOException,
                                         JsonReadException

Throws:

IOException

JsonReadException

readBoolean

public static boolean readBoolean(com.fasterxml.jackson.core.JsonParser parser)
                           throws IOException,
                                  JsonReadException

Throws:

IOException

JsonReadException

readDouble

public static double readDouble(com.fasterxml.jackson.core.JsonParser parser)
                         throws IOException,
                                JsonReadException

Throws:

IOException

JsonReadException

readEnum

public static <T> T readEnum(com.fasterxml.jackson.core.JsonParser parser,
                             HashMap<String,T> values,
                             T catch_all)
                      throws IOException,
                             JsonReadException

Throws:

IOException

JsonReadException

readFully

public T readFully(InputStream utf8Body)
            throws IOException,
                   JsonReadException

Throws:

IOException

JsonReadException

readFully

public T readFully(String body)
            throws JsonReadException

Throws:

JsonReadException

readFully

public T readFully(byte[] utf8Body)
            throws JsonReadException

Throws:

JsonReadException

readFromFile

public T readFromFile(String filePath)
               throws JsonReader.FileLoadException

Throws:

JsonReader.FileLoadException

readFromFile

public T readFromFile(File file)
               throws JsonReader.FileLoadException

Throws:

JsonReader.FileLoadException

readFully

public T readFully(com.fasterxml.jackson.core.JsonParser parser)
            throws IOException,
                   JsonReadException

Throws:

IOException

JsonReadException