Package com.google.api.client.http.xml.atom

Class AtomContent

java.lang.Object
com.google.api.client.http.AbstractHttpContent
com.google.api.client.http.xml.AbstractXmlHttpContent
com.google.api.client.http.xml.atom.AtomContent
All Implemented Interfaces:
HttpContent, StreamingContent
@Beta 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 AbstractHttpContent.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.

Since:
1.4

  • Field Details

    • isEntry

      private final boolean isEntry
      true for an Atom entry or false for an Atom feed.

    • entry

      private final Object entry
      Key/value pair data for the Atom entry.

  • Constructor Details

    • AtomContent

      protected AtomContent(XmlNamespaceDictionary namespaceDictionary, Object entry, boolean isEntry)
      Parameters:
      namespaceDictionary - XML namespace dictionary
      entry - key/value pair data for the Atom entry
      isEntry - true for an Atom entry or false for an Atom feed
      Since:
      1.5

  • Method Details

    • forEntry

      public static AtomContent forEntry(XmlNamespaceDictionary namespaceDictionary, Object entry)
      Returns a new instance of HTTP content for an Atom entry.
      Parameters:
      namespaceDictionary - XML namespace dictionary
      entry - data key/value pair for the Atom entry
      Since:
      1.5

    • forFeed

      public static AtomContent forFeed(XmlNamespaceDictionary namespaceDictionary, Object feed)
      Returns a new instance of HTTP content for an Atom feed.
      Parameters:
      namespaceDictionary - XML namespace dictionary
      feed - data key/value pair for the Atom feed
      Since:
      1.5

    • setMediaType

      public AtomContent 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 AbstractXmlHttpContent

    • writeTo

      public final void writeTo(org.xmlpull.v1.XmlSerializer serializer) throws IOException
      Description copied from class: AbstractXmlHttpContent
      Writes the content to the given XML serializer.
      Specified by:
      writeTo in class AbstractXmlHttpContent
      Throws:
      IOException - I/O exception

    • isEntry

      public final boolean isEntry()
      Returns true for an Atom entry or false for an Atom feed.
      Since:
      1.5

    • getData

      public final Object getData()
      Returns the key name/value pair data for the Atom entry or Atom feed.
      Since:
      1.5