public class AtomContent extends AbstractXmlHttpContent
Beta
Serializes Atom XML HTTP content based on the data key/value mapping object for an Atom entry.
Default value for #getType() is Atom#MEDIA_TYPE.
Sample usages:
static void setAtomEntryContent( HttpRequest request, XmlNamespaceDictionary namespaceDictionary, Object entry) { request.setContent(AtomContent.forEntry(namespaceDictionary, entry)); }
static void setAtomBatchContent( HttpRequest request, XmlNamespaceDictionary namespaceDictionary, Object batchFeed) { request.setContent(AtomContent.forFeed(namespaceDictionary, batchFeed)); }
Implementation is not thread-safe.
Static Methods
forEntry(XmlNamespaceDictionary namespaceDictionary, Object entry)
public static AtomContent forEntry(XmlNamespaceDictionary namespaceDictionary, Object entry)
Returns a new instance of HTTP content for an Atom entry.
Parameters | |
---|---|
Name | Description |
namespaceDictionary |
XmlNamespaceDictionary XML namespace dictionary |
entry |
Object data key/value pair for the Atom entry |
Returns | |
---|---|
Type | Description |
AtomContent |
forFeed(XmlNamespaceDictionary namespaceDictionary, Object feed)
public static AtomContent forFeed(XmlNamespaceDictionary namespaceDictionary, Object feed)
Returns a new instance of HTTP content for an Atom feed.
Parameters | |
---|---|
Name | Description |
namespaceDictionary |
XmlNamespaceDictionary XML namespace dictionary |
feed |
Object data key/value pair for the Atom feed |
Returns | |
---|---|
Type | Description |
AtomContent |
Constructors
AtomContent(XmlNamespaceDictionary namespaceDictionary, Object entry, boolean isEntry)
protected AtomContent(XmlNamespaceDictionary namespaceDictionary, Object entry, boolean isEntry)
Parameters | |
---|---|
Name | Description |
namespaceDictionary |
XmlNamespaceDictionary XML namespace dictionary |
entry |
Object key/value pair data for the Atom entry |
isEntry |
boolean
|
Methods
getData()
public final Object getData()
Returns the key name/value pair data for the Atom entry or Atom feed.
Returns | |
---|---|
Type | Description |
Object |
isEntry()
public final boolean isEntry()
Returns true
for an Atom entry or false
for an Atom feed.
Returns | |
---|---|
Type | Description |
boolean |
setMediaType(HttpMediaType mediaType)
public AtomContent setMediaType(HttpMediaType mediaType)
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.
Parameter | |
---|---|
Name | Description |
mediaType |
HttpMediaType |
Returns | |
---|---|
Type | Description |
AtomContent |
writeTo(XmlSerializer serializer)
public final void writeTo(XmlSerializer serializer)
Writes the content to the given XML serializer.
Parameter | |
---|---|
Name | Description |
serializer |
org.xmlpull.v1.XmlSerializer |
Exceptions | |
---|---|
Type | Description |
IOException |