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

java.lang.Object
  com.google.api.client.xml.atom.AbstractAtomFeedParser<T>

Type Parameters:

T - feed type

Direct Known Subclasses:

AtomFeedParser, AtomFeedParser

public abstract class AbstractAtomFeedParser<T>
extends Object

Abstract base class for an Atom feed parser when the feed type is known in advance.

Since:

1.0

Author:

Yaniv Inbar

Field Summary

Class<T>	feedClass Feed class to parse.
InputStream	inputStream Input stream to read.
XmlNamespaceDictionary	namespaceDictionary XML namespace dictionary.
org.xmlpull.v1.XmlPullParser	parser XML pull parser to use.

Constructor Summary

AbstractAtomFeedParser()

Method Summary

void	close() Closes the underlying parser.
protected abstract Object	parseEntryInternal() Parses a single entry.
T	parseFeed() Parse the feed and return a new parsed instance of the feed type.
Object	parseNextEntry() Parse the next item in the feed and return a new parsed instance of the item type.

Methods inherited from class java.lang.Object

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

Field Detail

parser

public org.xmlpull.v1.XmlPullParser parser

XML pull parser to use.

inputStream

public InputStream inputStream

Input stream to read.

feedClass

public Class<T> feedClass

Feed class to parse.

namespaceDictionary

public XmlNamespaceDictionary namespaceDictionary

XML namespace dictionary.

Constructor Detail

AbstractAtomFeedParser

public AbstractAtomFeedParser()

Method Detail

parseFeed

public T parseFeed()
            throws IOException,
                   org.xmlpull.v1.XmlPullParserException

Parse the feed and return a new parsed instance of the feed type. This method can be skipped if all you want are the items.

Throws:

IOException - I/O exception

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

parseNextEntry

public Object parseNextEntry()
                      throws IOException,
                             org.xmlpull.v1.XmlPullParserException

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 close().

Throws:

IOException - I/O exception

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

close

public void close()
           throws IOException

Closes the underlying parser.

Throws:

IOException

parseEntryInternal

protected abstract Object parseEntryInternal()
                                      throws IOException,
                                             org.xmlpull.v1.XmlPullParserException

Parses a single entry.

Returns:

object representing the entry

Throws:

IOException - I/O exception

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