com.amazonservices.mws.client

Class MwsXmlWriter

java.lang.Object

com.amazonservices.mws.client.MwsXmlWriter

All Implemented Interfaces:

MwsWriter, Closeable, AutoCloseable

Direct Known Subclasses:

MwsXmlBuilder

public class MwsXmlWriter
extends Object
implements MwsWriter

An MwsWriter that writes XML to a StringBuilder.

Author:

mayerj

Field Summary

Fields

Modifier and Type	Field and Description
protected Writer	writer Writer to write output to.

Constructor Summary

Constructors

Constructor and Description
MwsXmlWriter(Writer writer) Create instance that outputs to a java.io.Writer.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	append(String v) Append a string to the output.
protected void	append(String v, int start, int end) Append range of a string to the output.
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.

Methods inherited from class java.lang.Object

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

Field Detail

writer

protected Writer writer

Writer to write output to.

Constructor Detail

MwsXmlWriter

public MwsXmlWriter(Writer writer)

Create instance that outputs to a java.io.Writer.

Parameters:

writer - The writer to wrap.

Method Detail

append

protected void append(String v)

Append a string to the output.

Parameters:

v -

append

protected void append(String v,
          int start,
          int end)

Append range of a string to the output.

Parameters:

v -

start -

end -

beginObject

public void beginObject(String name)

Description copied from interface: MwsWriter

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>

Specified by:

beginObject in interface MwsWriter

close

public void close()

Specified by:

close in interface MwsWriter

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

endObject

public void endObject(String name)

Description copied from interface: MwsWriter

Write the end of an object value.

Must previously have written a matching beginObject.

For JSON writes: }

For XML writes: </name>

Specified by:

endObject in interface MwsWriter

write

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

Description copied from interface: MwsWriter

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); }

Specified by:

write in interface MwsWriter

name - The label for the value.

value - The value to output.

write

public void write(String name,
         Object value)

Description copied from interface: MwsWriter

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>

Specified by:

write in interface MwsWriter

Parameters:

name - The label for the value.

value - The value to output.

writeAttribute

public void writeAttribute(String name,
                  Object value)

Description copied from interface: MwsWriter

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.

Specified by:

writeAttribute in interface MwsWriter

writeList

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

Description copied from interface: MwsWriter

Write a list using sibling elements.

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

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

Specified by:

writeList in interface MwsWriter

writeList

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

Description copied from interface: MwsWriter

Write a list using child elements.

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

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

Specified by:

writeList in interface MwsWriter

writeAny

public void writeAny(Collection<Element> elements)

Description copied from interface: MwsWriter

Write a list of arbitrary elements.

Specified by:

writeAny in interface MwsWriter

Parameters:

elements - Collection of w3c DOM elements to write

writeValue

public void writeValue(Object value)

Description copied from interface: MwsWriter

Write out an unlabeled value.

Calling with null value does nothing and returns.

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

For XML: value

Specified by:

writeValue in interface MwsWriter

Parameters:

value - The object value.