com.amazonaws.transform

Class JsonUnmarshallerContext

java.lang.Object

com.amazonaws.transform.JsonUnmarshallerContext

Direct Known Subclasses:

JsonUnmarshallerContextImpl

public abstract class JsonUnmarshallerContext
extends Object

Used effectively as the API to access the context of performing the json-related unmarshalling.

For full support, see JsonUnmarshallerContextImpl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonUnmarshallerContext.UnmarshallerType

Constructor Summary

Constructors

Constructor and Description
JsonUnmarshallerContext()

Method Summary

Modifier and Type	Method and Description
int	getCurrentDepth() Returns the element depth of the parser's current position in the JSON document being parsed.
String	getCurrentParentElement() Returns the name of the JSON field that is the nearest parent of the current context.Returns null by default.
com.fasterxml.jackson.core.JsonToken	getCurrentToken() Returns the current JsonToken that is to be parsed by the parser.
String	getHeader(String header) Returns the value of the header with the specified name from the response, or null if not present.
HttpResponse	getHttpResponse() Returns the original HttpResponse constructed for this request.
com.fasterxml.jackson.core.JsonParser	getJsonParser() Returns the JsonParser used for parsing the Json document.
String	getLastParsedParentElement() This will return the deleted string in stackString when doing update on the stack.
Map<String,String>	getMetadata() Returns any metadata collected through metadata expressions while this context was reading the JSON events from the JSON document.
<T> Unmarshaller<T,JsonUnmarshallerContext>	getUnmarshaller(Class<T> type) Returns the JsonUnmarshaller for the specified scalar type.
<T> Unmarshaller<T,JsonUnmarshallerContext>	getUnmarshaller(Class<T> type, JsonUnmarshallerContext.UnmarshallerType unmarshallerType) Returns the JsonUnmarshaller for requested custom unmarshaller type.
boolean	isInsideResponseHeader() Returns true if the JsonUnmarshallerContext is involved in parsing response headers.
boolean	isStartOfDocument() Returns true if parsing of the Json document is yet to start.
com.fasterxml.jackson.core.JsonToken	nextToken() Returns the next JsonToken from the JsonParser.
com.fasterxml.jackson.core.JsonToken	peek() Returns the JsonToken which is to be parsed next.
String	readText() Returns the text of the current token, or throws an exception if the current token does not contain text (ex: '{', '}', etc.).
void	registerMetadataExpression(String expression, int targetDepth, String storageKey) Registers an expression, which if matched, will cause the data for the matching element to be stored in the metadata map under the specified key.
void	setCurrentHeader(String currentHeader) Sets the name of the response header that is to be read next.
boolean	testExpression(String expression) Tests the specified expression (a JSON field name) against the current position in the JSON document being parsed.
boolean	testExpression(String expression, int stackDepth) Tests the specified expression (a JSON field name) against the current position in the JSON document being parsed, and restricts the expression to matching at the specified stack depth.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonUnmarshallerContext

public JsonUnmarshallerContext()

Method Detail

getHeader

public String getHeader(String header)

Returns the value of the header with the specified name from the response, or null if not present.

Parameters:

header - The name of the header to lookup.

Returns:

The value of the header with the specified name from the response. Returns null by default or if the header is not present.

getHttpResponse

public HttpResponse getHttpResponse()

Returns the original HttpResponse constructed for this request. Returns null by default.

getCurrentDepth

public int getCurrentDepth()

Returns the element depth of the parser's current position in the JSON document being parsed.

Returns:

The element depth of the parser's current position in the JSON document being parsed. Returns -1 by default.

readText

public String readText()
                throws IOException

Returns the text of the current token, or throws an exception if the current token does not contain text (ex: '{', '}', etc.).

Returns:

The text of the current token. Returns null by default.

Throws:

IOException

isStartOfDocument

public boolean isStartOfDocument()

Returns true if parsing of the Json document is yet to start. Returns false by default or if the parsing of Json document is not yet started.

testExpression

public boolean testExpression(String expression)

Tests the specified expression (a JSON field name) against the current position in the JSON document being parsed.

Parameters:

expression - The field name to test.

Returns:

True if the expression matches the current document position, Returns false by default and in all other cases.

getCurrentParentElement

public String getCurrentParentElement()

Returns the name of the JSON field that is the nearest parent of the current context.Returns null by default.

testExpression

public boolean testExpression(String expression,
                              int stackDepth)

Tests the specified expression (a JSON field name) against the current position in the JSON document being parsed, and restricts the expression to matching at the specified stack depth.

Parameters:

expression - The field name to test.

stackDepth - The depth in the stack representing where the expression must start matching in order for this method to return true.

Returns:

True if the specified expression matches the current position in the JSON document, starting from the specified depth. Returns false by default.

nextToken

public com.fasterxml.jackson.core.JsonToken nextToken()
                                               throws IOException

Returns the next JsonToken from the JsonParser. Returns null by default.

Throws:

IOException

peek

public com.fasterxml.jackson.core.JsonToken peek()
                                          throws IOException

Returns the JsonToken which is to be parsed next. Returns null by default.

Throws:

IOException

getJsonParser

public com.fasterxml.jackson.core.JsonParser getJsonParser()

Returns the JsonParser used for parsing the Json document. Returns null by default.

getMetadata

public Map<String,String> getMetadata()

Returns any metadata collected through metadata expressions while this context was reading the JSON events from the JSON document.

Returns:

A map of any metadata collected through metadata expressions while this context was reading the JSON document. Returns an empty map by default.

registerMetadataExpression

public void registerMetadataExpression(String expression,
                                       int targetDepth,
                                       String storageKey)

Registers an expression, which if matched, will cause the data for the matching element to be stored in the metadata map under the specified key.

Parameters:

expression - The expression an element must match in order for it's data to be pulled out and stored in the metadata map.

targetDepth - The depth in the JSON document where the expression match must start.

storageKey - The key under which to store the matching element's data.

setCurrentHeader

public void setCurrentHeader(String currentHeader)

Sets the name of the response header that is to be read next.

getCurrentToken

public com.fasterxml.jackson.core.JsonToken getCurrentToken()

Returns the current JsonToken that is to be parsed by the parser. Returns null by default.

getLastParsedParentElement

public String getLastParsedParentElement()

This will return the deleted string in stackString when doing update on the stack. Returns null by default.

isInsideResponseHeader

public boolean isInsideResponseHeader()

Returns true if the JsonUnmarshallerContext is involved in parsing response headers. Else returns false. Returns true by default.

getUnmarshaller

public <T> Unmarshaller<T,JsonUnmarshallerContext> getUnmarshaller(Class<T> type)

Returns the JsonUnmarshaller for the specified scalar type. Returns null by default.

getUnmarshaller

public <T> Unmarshaller<T,JsonUnmarshallerContext> getUnmarshaller(Class<T> type,
                                                                   JsonUnmarshallerContext.UnmarshallerType unmarshallerType)

Returns the JsonUnmarshaller for requested custom unmarshaller type. Returns null by default.