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

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

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

Implementation is not thread-safe.

Since:

1.4

Author:

Yaniv Inbar

Field Summary

Class<E>

entryClass Deprecated. (scheduled to be made private final in 1.6) Use getEntryClass()

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

feedClass, inputStream, namespaceDictionary, parser

Constructor Summary

AtomFeedParser()
Deprecated. (scheduled to be removed in 1.6) Use AtomFeedParser(XmlNamespaceDictionary, XmlPullParser, InputStream, Class, Class)

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

Method Summary

static <T,E> AtomFeedParser<T,E>	create(HttpResponse response, XmlNamespaceDictionary namespaceDictionary, Class<T> feedClass, Class<E> entryClass) Parses the given HTTP response using the given feed class and entry class.
Class<E>	getEntryClass() Returns the Atom entry class to parse.
protected 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

Field Detail

entryClass

@Deprecated
public Class<E> entryClass

Deprecated. (scheduled to be made private final in 1.6) Use getEntryClass()

Atom entry class to parse.

Constructor Detail

AtomFeedParser

@Deprecated
public AtomFeedParser()

Deprecated. (scheduled to be removed in 1.6) Use AtomFeedParser(XmlNamespaceDictionary, XmlPullParser, InputStream, Class, Class)

AtomFeedParser

public AtomFeedParser(XmlNamespaceDictionary namespaceDictionary,
                      org.xmlpull.v1.XmlPullParser parser,
                      InputStream inputStream,
                      Class<T> feedClass,
                      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 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:

IOException - I/O exception

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

parseEntryInternal

protected Object parseEntryInternal()
                             throws 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:

IOException - I/O exception

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

getEntryClass

public final 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,
                                               Class<T> feedClass,
                                               Class<E> entryClass)
                                  throws 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:

IOException - I/O exception

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