com.google.api.client.http.xml

Class AbstractXmlHttpContent

java.lang.Object

com.google.api.client.http.AbstractHttpContent

com.google.api.client.http.xml.AbstractXmlHttpContent

All Implemented Interfaces:

HttpContent, StreamingContent

Direct Known Subclasses:

AtomContent, XmlHttpContent

public abstract class AbstractXmlHttpContent
extends AbstractHttpContent

Abstract serializer for XML HTTP content based on the data key/value mapping object for an item.

Implementation is not thread-safe.

Since:

1.0

Author:

Yaniv Inbar

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractXmlHttpContent(XmlNamespaceDictionary namespaceDictionary)

Method Summary

Methods

Modifier and Type	Method and Description
XmlNamespaceDictionary	getNamespaceDictionary() Returns the XML namespace dictionary.
AbstractXmlHttpContent	setMediaType(HttpMediaType mediaType) Sets the media type to use for the Content-Type header, or null if unspecified.
void	writeTo(OutputStream out) Writes the byte content to the given output stream.
protected abstract void	writeTo(org.xmlpull.v1.XmlSerializer serializer) Writes the content to the given XML serializer.

Methods inherited from class com.google.api.client.http.AbstractHttpContent

computeLength, computeLength, getCharset, getEncoding, getLength, getMediaType, getType, retrySupported

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractXmlHttpContent

protected AbstractXmlHttpContent(XmlNamespaceDictionary namespaceDictionary)

Parameters:

namespaceDictionary - XML namespace dictionary

Since:

1.5

Method Detail

writeTo

public final void writeTo(OutputStream out)
                   throws IOException

Description copied from interface: HttpContent

Writes the byte content to the given output stream.

Implementations must not close the output stream, and instead should flush the output stream. Some callers may assume that the the output stream has not been closed, and will fail to work if it has been closed.

Upgrade warning: in prior version 1.13 the implementation of this method was allowed to close the stream, but starting with 1.14 closing the stream is no longer allowed.

Parameters:

out - output stream

Throws:

IOException

setMediaType

public AbstractXmlHttpContent setMediaType(HttpMediaType mediaType)

Description copied from class: AbstractHttpContent

Sets the media type to use for the Content-Type header, or null if unspecified.

This will also overwrite any previously set parameter of the media type (for example "charset"), and therefore might change other properties as well.

Overrides:

setMediaType in class AbstractHttpContent

getNamespaceDictionary

public final XmlNamespaceDictionary getNamespaceDictionary()

Returns the XML namespace dictionary.

Since:

1.5

writeTo

protected abstract void writeTo(org.xmlpull.v1.XmlSerializer serializer)
                         throws IOException

Writes the content to the given XML serializer.

Throws:

IOException - I/O exception