Package com.metreeca.xml.formats

Class XMLFormat

java.lang.Object

com.metreeca.rest.Format<Document>

com.metreeca.xml.formats.XMLFormat

public final class XMLFormat
extends Format<Document>

XML message format.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MIME	The default MIME type for XML message bodies ("application/xml").
static final Pattern	MIMEPattern	A pattern matching XML-based MIME types, for instance application/rss+xml.

Fields inherited from class com.metreeca.rest.Format

MIMEDefault

Method Summary

Modifier and Type	Method	Description
Either<MessageException,Document>	decode(Message<?> message)	Decodes the XML message body from the input stream supplied by the message InputFormat body, if one is available and the message Content-Type header is matched by MIMEPattern, taking into account the message charset
<M extends Message<M>> M	encode(M message, Document value)	Configures message Content-Type header to "application/xml", unless already defined, and encodes the XML value into the output stream accepted by the message OutputFormat body, taking into account the message charset
String	mime()
static XMLFormat	xml()	Creates an XML message format.
static Either<TransformerException,Document>	xml(InputStream input)	Parses a XML document.
static Either<TransformerException,Document>	xml(InputStream input, String base)	Parses a XML document.
static Either<TransformerException,Document>	xml(Source source)	Parses a XML document.
static XMLFormat	xml(XMLReader parser)	Creates an XML message format using a custom SAX parser.

Methods inherited from class com.metreeca.rest.Format

equals, hashCode, langs, mime, mimes

Methods inherited from class java.lang.Object

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

Field Details

MIME

public static final String MIME

The default MIME type for XML message bodies ("application/xml").

See Also:

• Constant Field Values

MIMEPattern

public static final Pattern MIMEPattern

A pattern matching XML-based MIME types, for instance application/rss+xml.

Method Details

xml

public static XMLFormat xml()

Creates an XML message format.

Returns:

a new XML message format

xml

public static XMLFormat xml(XMLReader parser)

Creates an XML message format using a custom SAX parser.

Parameters:

parser - the custom SAX parser

Returns:

a new XML message format a custom SAX parser

Throws:

NullPointerException - if parser is null

xml

public static Either<TransformerException,Document> xml(InputStream input)

Parses a XML document.

Parameters:

input - the input stream the XML document is to be parsed from

Returns:

either a parsing exception or the XML document parsed from input

Throws:

NullPointerException - if input is null

xml

public static Either<TransformerException,Document> xml(InputStream input,
 String base)

Parses a XML document.

Parameters:

input - the input stream the XML document is to be parsed from

base - the possibly null base URL for the XML document to be parsed

Returns:

either a parsing exception or the XML document parsed from input

Throws:

NullPointerException - if input is null

xml

public static Either<TransformerException,Document> xml(Source source)

Parses a XML document.

Parameters:

source - the source the XML document is to be parsed from

Returns:

either a parsing exception or the XML document parsed from source

Throws:

NullPointerException - if source is null

mime

public String mime()

Overrides:

mime in class Format<Document>

Returns:

the default MIME type for XML messages ("application/xml")

decode

public Either<MessageException,Document> decode(Message<?> message)

Decodes the XML message body from the input stream supplied by the message InputFormat body, if one is available and the message Content-Type header is matched by MIMEPattern, taking into account the message charset

Overrides:

decode in class Format<Document>

encode

public <M extends Message<M>> M encode(M message,
 Document value)

Configures message Content-Type header to "application/xml", unless already defined, and encodes the XML value into the output stream accepted by the message OutputFormat body, taking into account the message charset

Overrides:

encode in class Format<Document>