Package 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
@Beta public abstract class AbstractAtomFeedParser<T> extends Object
Beta
Abstract base class for an Atom feed parser when the feed type is known in advance.Implementation is not thread-safe.
- Since:
- 1.0
- Author:
- Yaniv Inbar
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractAtomFeedParser(XmlNamespaceDictionary namespaceDictionary, org.xmlpull.v1.XmlPullParser parser, InputStream inputStream, Class<T> feedClass)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
close()
Closes the underlying parser.Class<T>
getFeedClass()
Returns the feed class to parse.InputStream
getInputStream()
Returns the input stream to read.XmlNamespaceDictionary
getNamespaceDictionary()
Returns the XML namespace dictionary.org.xmlpull.v1.XmlPullParser
getParser()
Returns the XML pull parser to use.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.
-
-
-
Constructor Detail
-
AbstractAtomFeedParser
protected AbstractAtomFeedParser(XmlNamespaceDictionary namespaceDictionary, org.xmlpull.v1.XmlPullParser parser, InputStream inputStream, Class<T> feedClass)
- Parameters:
namespaceDictionary
- XML namespace dictionaryparser
- XML pull parser to useinputStream
- input stream to readfeedClass
- feed class to parse- Since:
- 1.5
-
-
Method Detail
-
getParser
public final org.xmlpull.v1.XmlPullParser getParser()
Returns the XML pull parser to use.- Since:
- 1.5
-
getInputStream
public final InputStream getInputStream()
Returns the input stream to read.- Since:
- 1.5
-
getNamespaceDictionary
public final XmlNamespaceDictionary getNamespaceDictionary()
Returns the XML namespace dictionary.- Since:
- 1.5
-
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 exceptionorg.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 returnnull
and automatically close the parser (in which case there is no need to callclose()
.- Throws:
IOException
- I/O exceptionorg.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 exceptionorg.xmlpull.v1.XmlPullParserException
- XML pull parser exception
-
-