com.google.api.client.googleapis.xml.atom

Class AtomPatchRelativeToOriginalContent

java.lang.Object

com.google.api.client.http.AbstractHttpContent

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

com.google.api.client.googleapis.xml.atom.AtomPatchRelativeToOriginalContent

All Implemented Interfaces:

HttpContent, StreamingContent

@Beta
public final class AtomPatchRelativeToOriginalContent
extends AbstractXmlHttpContent

Beta
Serializes an optimal Atom XML PATCH HTTP content based on the data key/value mapping object for an Atom entry, by comparing the original value to the patched value.

Sample usage:

 static void setContent(HttpRequest request,
                        XmlNamespaceDictionary namespaceDictionary,
                        Object originalEntry, Object patchedEntry) {
   request.setContent(new AtomPatchRelativeToOriginalContent(
       namespaceDictionary, originalEntry, patchedEntry));
 }
 

Since:

1.0

Author:

Yaniv Inbar

Constructor Summary

Constructors

Constructor and Description
AtomPatchRelativeToOriginalContent(XmlNamespaceDictionary namespaceDictionary, Object originalEntry, Object patchedEntry)

Method Summary

Modifier and Type	Method and Description
Object	getOriginalEntry() Returns the data key name/value pairs for the original unmodified Atom entry.
Object	getPatchedEntry() Returns the data key name/value pairs for the updated/patched Atom entry.
AtomPatchRelativeToOriginalContent	setMediaType(HttpMediaType mediaType)
protected void	writeTo(org.xmlpull.v1.XmlSerializer serializer)

Methods inherited from class com.google.api.client.http.xml.AbstractXmlHttpContent

getNamespaceDictionary, writeTo

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AtomPatchRelativeToOriginalContent

public AtomPatchRelativeToOriginalContent(XmlNamespaceDictionary namespaceDictionary,
                                          Object originalEntry,
                                          Object patchedEntry)

Parameters:

namespaceDictionary - XML namespace dictionary

Since:

1.5

Method Detail

writeTo

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

Specified by:

writeTo in class AbstractXmlHttpContent

Throws:

IOException

setMediaType

public AtomPatchRelativeToOriginalContent setMediaType(HttpMediaType mediaType)

Overrides:

setMediaType in class AbstractXmlHttpContent

getPatchedEntry

public final Object getPatchedEntry()

Returns the data key name/value pairs for the updated/patched Atom entry.

Since:

1.5

getOriginalEntry

public final Object getOriginalEntry()

Returns the data key name/value pairs for the original unmodified Atom entry.

Since:

1.5