Class XmlIOUtil

java.lang.Object

io.protostuff.XmlIOUtil

public final class XmlIOUtil
extends Object

Utility for the XML serialization/deserialization of messages and objects tied to a schema.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XML_ENCODING
static final String	XML_VERSION

Constructor Summary

Constructors

Modifier	Constructor	Description
private	XmlIOUtil()

Method Summary

Modifier and Type	Method	Description
static <T> void	mergeFrom(byte[] data, int offset, int len, T message, Schema<T> schema)	Merges the message with the byte array using the given schema.
static <T> void	mergeFrom(byte[] data, int offset, int len, T message, Schema<T> schema, XMLInputFactory inFactory)	Merges the message with the byte array using the given schema.
static <T> void	mergeFrom(byte[] data, T message, Schema<T> schema)	Merges the message with the byte array using the given schema.
static <T> void	mergeFrom(InputStream in, T message, Schema<T> schema)	Merges the message from the InputStream using the given schema.
static <T> void	mergeFrom(InputStream in, T message, Schema<T> schema, XMLInputFactory inFactory)	Merges the message from the InputStream using the given schema.
static <T> void	mergeFrom(Reader r, T message, Schema<T> schema)	Merges the message from the Reader using the given schema.
static <T> void	mergeFrom(Reader r, T message, Schema<T> schema, XMLInputFactory inFactory)	Merges the message from the Reader using the given schema.
static <T> void	mergeFrom(XMLStreamReader parser, T message, Schema<T> schema)	Merges the message from the XMLStreamReader using the given schema.
static Pipe	newPipe(byte[] data)	Creates an xml pipe from a byte array.
static Pipe	newPipe(byte[] data, int offset, int length)	Creates an xml pipe from a byte array.
static Pipe	newPipe(InputStream in)	Creates an xml pipe from an InputStream.
static Pipe	newPipe(Reader reader)	Creates an xml pipe from a Reader.
static Pipe	newPipe(XMLStreamReader parser)	Creates an xml pipe from an XMLStreamReader.
static <T> List<T>	parseListFrom(InputStream in, Schema<T> schema)	Parses the messages from the InputStream using the given schema.
static <T> List<T>	parseListFrom(InputStream in, Schema<T> schema, XMLInputFactory inFactory)	Parses the messages from the InputStream using the given schema.
static <T> List<T>	parseListFrom(XMLStreamReader parser, Schema<T> schema)	Parses the messages from the XMLStreamReader using the given schema.
static <T> byte[]	toByteArray(T message, Schema<T> schema)	Serializes the message into a byte array.
static <T> byte[]	toByteArray(T message, Schema<T> schema, XMLOutputFactory outFactory)	Serializes the message into a byte array.
static <T> void	writeListTo(OutputStream out, List<T> messages, Schema<T> schema)	Serializes the messages into the OutputStream using the given schema.
static <T> void	writeListTo(OutputStream out, List<T> messages, Schema<T> schema, XMLOutputFactory outFactory)	Serializes the messages into the OutputStream using the given schema.
static <T> void	writeListTo(XMLStreamWriter writer, List<T> messages, Schema<T> schema)	Serializes the messages into the XMLStreamWriter using the given schema.
static <T> void	writeTo(OutputStream out, T message, Schema<T> schema)	Serializes the message into an OutputStream using the given schema.
static <T> void	writeTo(OutputStream out, T message, Schema<T> schema, XMLOutputFactory outFactory)	Serializes the message into an OutputStream using the given schema.
static <T> void	writeTo(Writer w, T message, Schema<T> schema)	Serializes the message into a Writer using the given schema.
static <T> void	writeTo(Writer w, T message, Schema<T> schema, XMLOutputFactory outFactory)	Serializes the message into a Writer using the given schema.
static <T> void	writeTo(XMLStreamWriter writer, T message, Schema<T> schema)	Serializes the message into an XMLStreamWriter using the given schema.

Methods inherited from class Object

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

Field Details

XML_ENCODING

public static final String XML_ENCODING

See Also:

• Constant Field Values

XML_VERSION

public static final String XML_VERSION

See Also:

• Constant Field Values

Constructor Details

XmlIOUtil

private XmlIOUtil()

Method Details

newPipe

public static Pipe newPipe(byte[] data)
                    throws IOException

Creates an xml pipe from a byte array.

Throws:

IOException

newPipe

public static Pipe newPipe(byte[] data,
 int offset,
 int length)
                    throws IOException

Creates an xml pipe from a byte array.

Throws:

IOException

newPipe

public static Pipe newPipe(InputStream in)
                    throws IOException

Creates an xml pipe from an InputStream.

Throws:

IOException

newPipe

public static Pipe newPipe(Reader reader)
                    throws IOException

Creates an xml pipe from a Reader.

Throws:

IOException

newPipe

public static Pipe newPipe(XMLStreamReader parser)

Creates an xml pipe from an XMLStreamReader.

mergeFrom

public static <T> void mergeFrom(byte[] data,
 T message,
 Schema<T> schema)

Merges the message with the byte array using the given schema.

mergeFrom

public static <T> void mergeFrom(byte[] data,
 int offset,
 int len,
 T message,
 Schema<T> schema)

Merges the message with the byte array using the given schema.

mergeFrom

public static <T> void mergeFrom(byte[] data,
 int offset,
 int len,
 T message,
 Schema<T> schema,
 XMLInputFactory inFactory)

Merges the message with the byte array using the given schema.

mergeFrom

public static <T> void mergeFrom(InputStream in,
 T message,
 Schema<T> schema)
                          throws IOException

Merges the message from the InputStream using the given schema.

Throws:

IOException

mergeFrom

public static <T> void mergeFrom(InputStream in,
 T message,
 Schema<T> schema,
 XMLInputFactory inFactory)
                          throws IOException

Merges the message from the InputStream using the given schema.

Throws:

IOException

mergeFrom

public static <T> void mergeFrom(Reader r,
 T message,
 Schema<T> schema)
                          throws IOException

Merges the message from the Reader using the given schema.

Throws:

IOException

mergeFrom

public static <T> void mergeFrom(Reader r,
 T message,
 Schema<T> schema,
 XMLInputFactory inFactory)
                          throws IOException

Merges the message from the Reader using the given schema.

Throws:

IOException

mergeFrom

public static <T> void mergeFrom(XMLStreamReader parser,
 T message,
 Schema<T> schema)
                          throws IOException,
XMLStreamException,
XmlInputException

Merges the message from the XMLStreamReader using the given schema.

Throws:

IOException

XMLStreamException

XmlInputException

toByteArray

public static <T> byte[] toByteArray(T message,
 Schema<T> schema)

Serializes the message into a byte array.

toByteArray

public static <T> byte[] toByteArray(T message,
 Schema<T> schema,
 XMLOutputFactory outFactory)

Serializes the message into a byte array.

writeTo

public static <T> void writeTo(OutputStream out,
 T message,
 Schema<T> schema)
                        throws IOException

Serializes the message into an OutputStream using the given schema.

Throws:

IOException

writeTo

public static <T> void writeTo(OutputStream out,
 T message,
 Schema<T> schema,
 XMLOutputFactory outFactory)
                        throws IOException

Serializes the message into an OutputStream using the given schema.

Throws:

IOException

writeTo

public static <T> void writeTo(Writer w,
 T message,
 Schema<T> schema)
                        throws IOException

Serializes the message into a Writer using the given schema.

Throws:

IOException

writeTo

public static <T> void writeTo(Writer w,
 T message,
 Schema<T> schema,
 XMLOutputFactory outFactory)
                        throws IOException

Serializes the message into a Writer using the given schema.

Throws:

IOException

writeTo

public static <T> void writeTo(XMLStreamWriter writer,
 T message,
 Schema<T> schema)
                        throws IOException,
XMLStreamException,
XmlOutputException

Serializes the message into an XMLStreamWriter using the given schema.

Throws:

IOException

XMLStreamException

XmlOutputException

writeListTo

public static <T> void writeListTo(OutputStream out,
 List<T> messages,
 Schema<T> schema)
                            throws IOException

Serializes the messages into the OutputStream using the given schema.

Throws:

IOException

writeListTo

public static <T> void writeListTo(OutputStream out,
 List<T> messages,
 Schema<T> schema,
 XMLOutputFactory outFactory)
                            throws IOException

Serializes the messages into the OutputStream using the given schema.

Throws:

IOException

writeListTo

public static <T> void writeListTo(XMLStreamWriter writer,
 List<T> messages,
 Schema<T> schema)
                            throws IOException,
XMLStreamException

Serializes the messages into the XMLStreamWriter using the given schema.

Throws:

IOException

XMLStreamException

parseListFrom

public static <T> List<T> parseListFrom(InputStream in,
 Schema<T> schema)
                                 throws IOException

Parses the messages from the InputStream using the given schema.

Throws:

IOException

parseListFrom

public static <T> List<T> parseListFrom(InputStream in,
 Schema<T> schema,
 XMLInputFactory inFactory)
                                 throws IOException

Parses the messages from the InputStream using the given schema.

Throws:

IOException

parseListFrom

public static <T> List<T> parseListFrom(XMLStreamReader parser,
 Schema<T> schema)
                                 throws IOException,
XMLStreamException

Parses the messages from the XMLStreamReader using the given schema.

Throws:

IOException

XMLStreamException