Package fish.payara.admin.rest.streams

Class XmlStreamWriter

java.lang.Object

fish.payara.admin.rest.streams.XmlStreamWriter

All Implemented Interfaces:

StreamWriter

public class XmlStreamWriter
extends Object
implements StreamWriter

A StreamWriter for handling XML.

Constructor Summary

Constructors

Constructor	Description
XmlStreamWriter(OutputStream os)	Creates a StreamWriter for handling XML, with a null prefix and postfix.
XmlStreamWriter(OutputStream os, String prefix, String postfix)	Creates a StreamWriter for handling XML.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the OutputStream associated with this object.
String	getPostfix()	Returns a string of data that must appear at the end of the data stream.
String	getPrefix()	Returns a string of data that must appear at the start of the data stream.
void	writeAttribute(String name, Boolean value)	Writes a Boolean attribute with the specified name and value.
void	writeAttribute(String name, String value)	Writes a String attribute with the specified name and value.
void	writeEndArray()	Writes the end of an array.
void	writeEndDocument()	Writes the data that is compulsory to appear at the end of the data structure.
void	writeEndObject()	Writes the end of an object.
void	writeStartArray(String element)	Writes the start of an array, with the specified name.
void	writeStartDocument()	Writes the data that is compulsory to appear at the start of the data structure.
void	writeStartObject(String element)	Writes the start of a new object, with the specified name.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlStreamWriter

public XmlStreamWriter(OutputStream os,
                       String prefix,
                       String postfix)
                throws XMLStreamException

Creates a StreamWriter for handling XML.

Parameters:

os - The OutputStream to write to.

prefix - Any data that needs writing at the start of the stream.

postfix - Any data that needs writing at the end of the stream.

Throws:

XMLStreamException - Thrown if any errors occur in creating the XML stream.

XmlStreamWriter

public XmlStreamWriter(OutputStream os)
                throws XMLStreamException

Creates a StreamWriter for handling XML, with a null prefix and postfix.

Parameters:

os - The OutputStream to write to.

Throws:

XMLStreamException - Thrown if any errors occur in creating the XML stream.

Method Detail

getPostfix

public String getPostfix()

Description copied from interface: StreamWriter

Returns a string of data that must appear at the end of the data stream.

Specified by:

getPostfix in interface StreamWriter

Returns:

postfix

getPrefix

public String getPrefix()

Description copied from interface: StreamWriter

Returns a string of data that must appear at the start of the data stream. E.g. a namespace declaration.

Specified by:

getPrefix in interface StreamWriter

Returns:

prefix

writeStartDocument

public void writeStartDocument()
                        throws XMLStreamException,
                               IOException

Description copied from interface: StreamWriter

Writes the data that is compulsory to appear at the start of the data structure.
E.g. for XML this might be: <?xml version="1.0" ?>

Specified by:

writeStartDocument in interface StreamWriter

Throws:

XMLStreamException

IOException

writeEndDocument

public void writeEndDocument()
                      throws XMLStreamException,
                             IOException

Description copied from interface: StreamWriter

Writes the data that is compulsory to appear at the end of the data structure.

Specified by:

writeEndDocument in interface StreamWriter

Throws:

XMLStreamException

IOException

writeStartObject

public void writeStartObject(String element)
                      throws XMLStreamException

Description copied from interface: StreamWriter

Writes the start of a new object, with the specified name.

Specified by:

writeStartObject in interface StreamWriter

Parameters:

element - The name of the object

Throws:

XMLStreamException

writeEndObject

public void writeEndObject()
                    throws XMLStreamException

Description copied from interface: StreamWriter

Writes the end of an object. An object must have been started, or an exception will be thrown.

Specified by:

writeEndObject in interface StreamWriter

Throws:

XMLStreamException

writeAttribute

public void writeAttribute(String name,
                           String value)
                    throws XMLStreamException

Description copied from interface: StreamWriter

Writes a String attribute with the specified name and value. E.g. for JSON this will write: "name":"value".

Specified by:

writeAttribute in interface StreamWriter

Parameters:

name - The name of the attribute

value - The value of the attribute

Throws:

XMLStreamException

writeAttribute

public void writeAttribute(String name,
                           Boolean value)
                    throws XMLStreamException

Description copied from interface: StreamWriter

Writes a Boolean attribute with the specified name and value. E.g. for JSON this will write: "name":true/false.

Specified by:

writeAttribute in interface StreamWriter

Parameters:

name - The name of the attribute

value - The value of the attribute

Throws:

XMLStreamException

close

public void close()
           throws XMLStreamException

Description copied from interface: StreamWriter

Closes the OutputStream associated with this object. Some OutputStreams require closing before any data will be written.

Specified by:

close in interface StreamWriter

Throws:

XMLStreamException

writeStartArray

public void writeStartArray(String element)
                     throws Exception

Description copied from interface: StreamWriter

Writes the start of an array, with the specified name. If the data structure doesn't support arrays, this method will do nothing.

Specified by:

writeStartArray in interface StreamWriter

Parameters:

element - The name of the array

Throws:

Exception - Any exception thrown while writing. E.g. for JSON this might be a JsonGenerationException.

writeEndArray

public void writeEndArray()
                   throws Exception

Description copied from interface: StreamWriter

Writes the end of an array. An array must have been started, or an exception will be thrown. If the data structure doesn't support arrays, this method will do nothing.

Specified by:

writeEndArray in interface StreamWriter

Throws:

Exception - Any exception thrown while writing. E.g. for JSON this might be a JsonGenerationException.