com.google.api.client.googleapis.json

Class JsonCParser

java.lang.Object

com.google.api.client.json.JsonObjectParser

com.google.api.client.googleapis.json.JsonCParser

All Implemented Interfaces:

com.google.api.client.util.ObjectParser

public final class JsonCParser
extends com.google.api.client.json.JsonObjectParser

Parses JSON-C response content into an data class of key/value pairs, assuming the data is wrapped in a "data" envelope.

Warning: this should only be used by some older Google APIs that wrapped the response in a "data" envelope. All newer Google APIs don't use this envelope, and for those APIs JsonObjectParser should be used instead.

Sample usage:

 
  static void setParser(HttpRequest request) {
    request.setParser(new JsonCParser(new JacksonFactory()));
  }
 
 

Implementation is thread-safe.

Upgrade warning: this class now extends JsonObjectParser, whereas in prior version 1.11 it extended JsonHttpParser.

Since:

1.0

Author:

Yaniv Inbar

Constructor Summary

Constructors

Constructor and Description
JsonCParser(com.google.api.client.json.JsonFactory jsonFactory)

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.json.JsonFactory	getFactory() Returns the JSON factory used for parsing.
static com.google.api.client.json.JsonParser	initializeParser(com.google.api.client.json.JsonParser parser) Initializes a JSON parser to use for parsing by skipping over the "data" or "error" envelope.
Object	parseAndClose(InputStream in, Charset charset, Type dataType)
Object	parseAndClose(Reader reader, Type dataType)

Methods inherited from class com.google.api.client.json.JsonObjectParser

getJsonFactory, parseAndClose, parseAndClose

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonCParser

public JsonCParser(com.google.api.client.json.JsonFactory jsonFactory)

Parameters:

jsonFactory - non-null JSON factory used for parsing

Since:

1.5

Method Detail

getFactory

public final com.google.api.client.json.JsonFactory getFactory()

Returns the JSON factory used for parsing.

Since:

1.10

initializeParser

public static com.google.api.client.json.JsonParser initializeParser(com.google.api.client.json.JsonParser parser)
                                                              throws IOException

Initializes a JSON parser to use for parsing by skipping over the "data" or "error" envelope.

The parser will be closed if any throwable is thrown. The current token will be the value of the "data" or "error key.

Parameters:

parser - the parser which should be initialized for normal parsing

Returns:

the parser which was passed as a parameter

Throws:

IllegalArgumentException - if content type is not Json.MEDIA_TYPE or if expected "data" or "error" key is not found

IOException

Since:

1.10

parseAndClose

public Object parseAndClose(InputStream in,
                   Charset charset,
                   Type dataType)
                     throws IOException

Specified by:

parseAndClose in interface com.google.api.client.util.ObjectParser

Overrides:

parseAndClose in class com.google.api.client.json.JsonObjectParser

Throws:

IOException

parseAndClose

public Object parseAndClose(Reader reader,
                   Type dataType)
                     throws IOException

Specified by:

parseAndClose in interface com.google.api.client.util.ObjectParser

Overrides:

parseAndClose in class com.google.api.client.json.JsonObjectParser

Throws:

IOException