com.amazonservices.mws.client

Interface MwsWriter

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

MwsCall

All Known Implementing Classes:

MwsJsonBuilder, MwsJsonWriter, MwsXmlBuilder, MwsXmlWriter

public interface MwsWriter
extends Closeable

Interface for objects that write data and complex types to some format. XML and JSON for example.

Author:

mayerj

Method Summary

Methods

Modifier and Type	Method and Description
void	beginObject(String name) Write a begin tag for an object value.
void	close()
void	endObject(String name) Write the end of an object value.
void	write(String name, Object value) Write out a value, with proper escaping and delimiters for the context.
void	write(String namespace, String name, MwsObject value) Write out an object with a namespace attribute.
void	writeAny(Collection<Element> elements) Write a list of arbitrary elements.
void	writeAttribute(String name, Object value) Write out a labeled attribute value with proper escaping and delimiters for the context.
void	writeList(String name, Collection<?> list) Write a list using sibling elements.
void	writeList(String name, String memberName, Collection<?> list) Write a list using child elements.
void	writeValue(Object value) Write out an unlabeled value.

Method Detail

beginObject

void beginObject(String name)

Write a begin tag for an object value. Can be nested.

Must follow with matching endObject call eventually.

For JSON writes [,]name: { or {

For XML writes <name>

Parameters:

name -

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

endObject

void endObject(String name)

Write the end of an object value.

Must previously have written a matching beginObject.

For JSON writes: }

For XML writes: </name>

Parameters:

name -

write

void write(String namespace,
         String name,
         MwsObject value)

Write out an object with a namespace attribute.

Same as calling: if (value!=null) { w.beginObject(name); w.writeAttribute("xmlns",name); value.writeFragmentTo(w); w.endObject(name); }

Parameters:

name - The label for the value.

value - The value to output.

write

void write(String name,
         Object value)

Write out a value, with proper escaping and delimiters for the context. May be called nested in beginObject/endObject.

The value must be one of: null, Boolean, Number, String, MwsObject.

Calling with a null value does nothing and returns.

For JSON: [,]label:value or [,]value

For XML: <label>valueFragment</label>

Parameters:

name - The label for the value.

value - The value to output.

writeAttribute

void writeAttribute(String name,
                  Object value)

Write out a labeled attribute value with proper escaping and delimiters for the context.

Can only be called after beginObject or writeAttribute methods.

The value must be one of: null, Boolean, Number, String.

Calling with a null value does nothing and returns.

For JSON: same as write(name,value)

For XML: label = "value" inside the object tag.

Parameters:

name -

value -

writeList

void writeList(String name,
             Collection<?> list)

Write a list using sibling elements.

For JSON: [,]name:[values...] or [values...]

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

Parameters:

name -

list -

writeList

void writeList(String name,
             String memberName,
             Collection<?> list)

Write a list using child elements.

For JSON: [,]name:[values...] or [values...]

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

Parameters:

name -

memberName -

list -

writeAny

void writeAny(Collection<Element> elements)

Write a list of arbitrary elements.

Parameters:

elements - Collection of w3c DOM elements to write

writeValue

void writeValue(Object value)

Write out an unlabeled value.

Calling with null value does nothing and returns.

For JSON: [,]Value:value or [,]value

For XML: value

Parameters:

value - The object value.