com.amazonservices.mws.client

Interface MwsReader

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

MwsXmlReader

public interface MwsReader
extends Closeable

Methods to read an object from XML, JSON or other serial form.

MwsReader instances can wrap an input stream or other resource and should be closed to avoid resource leakage.

Author:

mayerj

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
<T> T	read(String name, Class<T> cls) Read the next labeled value.
List<Element>	readAny() Read a list of all elements, ignoring type and name.
<T> T	readAttribute(String name, Class<T> cls) Get an attribute by name.
<T> List<T>	readList(String memberName, Class<T> cls) Read a list of sibling elements.
<T> List<T>	readList(String name, String memberName, Class<T> cls) Read a list of child elements.
<T> T	readValue(Class<T> cls) Read raw string value.

Method Detail

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

read

<T> T read(String name,
         Class<T> cls)

Read the next labeled value.

Returns null if the reader is not positioned on a labeled value of the requested type.

For XML reads: <name>value</name>

For JSON reads: name:value if in Object or value if in list.

Parameters:

name - The expected label.

cls - The expected value class.

Returns:

The read in value.

readAttribute

<T> T readAttribute(String name,
                  Class<T> cls)

Get an attribute by name.

Called when positioned on begin Object.

Returns null if the named attribute is not present.

Parameters:

name - The attribute name to get.

Returns:

The attribute value or null of not set.

readList

<T> List<T> readList(String memberName,
                   Class<T> cls)

Read a list of sibling elements.

For XML reads: <memberName>value</memberName>...

For JSON reads: name:[value...] or [value...]

Parameters:

memberName - XML tag name of each member

cls -

Returns:

A List.

readList

<T> List<T> readList(String name,
                   String memberName,
                   Class<T> cls)

Read a list of child elements.

For XML reads: <name><memberName>value</memberName>...

For JSON reads: name:[value...] or [value...]

Parameters:

name - XML tag name of list parent

memberName - XML tag name of each member

cls -

Returns:

A List.

readAny

List<Element> readAny()

Read a list of all elements, ignoring type and name.

Returns:

A List of w3c DOM Elements

readValue

<T> T readValue(Class<T> cls)

Read raw string value.

For XML reads: characters up to next tag.

For JSON reads: "characters"

Returns:

The read in string value.