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

Class AtomFeedParser<T,E>

java.lang.Object

com.google.api.client.xml.atom.AbstractAtomFeedParser<T>

com.google.api.client.http.xml.atom.AtomFeedParser<T,E>

Type Parameters:

T - feed type

E - entry type

@Beta
public final class AtomFeedParser<T,E>
extends AbstractAtomFeedParser<T>

Beta
Atom feed pull parser when the Atom entry class is known in advance.

Implementation is not thread-safe.

Since:

1.4

Author:

Yaniv Inbar

Constructor Summary

Constructors

Constructor and Description
AtomFeedParser(XmlNamespaceDictionary namespaceDictionary, org.xmlpull.v1.XmlPullParser parser, java.io.InputStream inputStream, java.lang.Class<T> feedClass, java.lang.Class<E> entryClass)

Method Summary

Methods

Modifier and Type	Method and Description
static <T,E> AtomFeedParser<T,E>	create(HttpResponse response, XmlNamespaceDictionary namespaceDictionary, java.lang.Class<T> feedClass, java.lang.Class<E> entryClass) Parses the given HTTP response using the given feed class and entry class.
java.lang.Class<E>	getEntryClass() Returns the Atom entry class to parse.
protected java.lang.Object	parseEntryInternal() Parses a single entry.
E	parseNextEntry() Parse the next item in the feed and return a new parsed instance of the item type.

Methods inherited from class com.google.api.client.xml.atom.AbstractAtomFeedParser

close, getFeedClass, getInputStream, getNamespaceDictionary, getParser, parseFeed

Methods inherited from class java.lang.Object

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

Constructor Detail

AtomFeedParser

public AtomFeedParser(XmlNamespaceDictionary namespaceDictionary,
              org.xmlpull.v1.XmlPullParser parser,
              java.io.InputStream inputStream,
              java.lang.Class<T> feedClass,
              java.lang.Class<E> entryClass)

Parameters:

namespaceDictionary - XML namespace dictionary

parser - XML pull parser to use

inputStream - input stream to read

feedClass - feed class to parse

Since:

1.5

Method Detail

parseNextEntry

public E parseNextEntry()
                 throws java.io.IOException,
                        org.xmlpull.v1.XmlPullParserException

Description copied from class: AbstractAtomFeedParser

Parse the next item in the feed and return a new parsed instance of the item type. If there is no item to parse, it will return null and automatically close the parser (in which case there is no need to call AbstractAtomFeedParser.close().

Overrides:

parseNextEntry in class AbstractAtomFeedParser<T>

Throws:

java.io.IOException - I/O exception

org.xmlpull.v1.XmlPullParserException - XML pull parser exception

parseEntryInternal

protected java.lang.Object parseEntryInternal()
                                       throws java.io.IOException,
                                              org.xmlpull.v1.XmlPullParserException

Description copied from class: AbstractAtomFeedParser

Parses a single entry.

Specified by:

parseEntryInternal in class AbstractAtomFeedParser<T>

Returns:

object representing the entry

Throws:

java.io.IOException - I/O exception

org.xmlpull.v1.XmlPullParserException - XML pull parser exception

getEntryClass

public final java.lang.Class<E> getEntryClass()

Returns the Atom entry class to parse.

Since:

1.5

create

public static <T,E> AtomFeedParser<T,E> create(HttpResponse response,
                               XmlNamespaceDictionary namespaceDictionary,
                               java.lang.Class<T> feedClass,
                               java.lang.Class<E> entryClass)
                                  throws java.io.IOException,
                                         org.xmlpull.v1.XmlPullParserException

Parses the given HTTP response using the given feed class and entry class.

Type Parameters:

T - feed type

E - entry type

Parameters:

response - HTTP response

namespaceDictionary - XML namespace dictionary

feedClass - feed class

entryClass - entry class

Returns:

Atom feed parser

Throws:

java.io.IOException - I/O exception

org.xmlpull.v1.XmlPullParserException - XML pull parser exception