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
Abstract base class for an Atom feed parser when the feed type is known in advance.
Implementation is not thread-safe.
- Since:
- 1.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionFeed class to parse.private boolean
Whether the feed has been parsed.private final InputStream
Input stream to read.private final XmlNamespaceDictionary
XML namespace dictionary.private final org.xmlpull.v1.XmlPullParser
XML pull parser to use. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
AbstractAtomFeedParser
(XmlNamespaceDictionary namespaceDictionary, org.xmlpull.v1.XmlPullParser parser, InputStream inputStream, Class<T> feedClass) -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Closes the underlying parser.Returns the feed class to parse.final InputStream
Returns the input stream to read.final XmlNamespaceDictionary
Returns the XML namespace dictionary.final org.xmlpull.v1.XmlPullParser
Returns the XML pull parser to use.protected abstract Object
Parses a single entry.Parse the feed and return a new parsed instance of the feed type.Parse the next item in the feed and return a new parsed instance of the item type.
-
Field Details
-
feedParsed
private boolean feedParsedWhether the feed has been parsed. -
parser
private final org.xmlpull.v1.XmlPullParser parserXML pull parser to use. -
inputStream
Input stream to read. -
feedClass
Feed class to parse. -
namespaceDictionary
XML namespace dictionary.
-
-
Constructor Details
-
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 Details
-
getParser
public final org.xmlpull.v1.XmlPullParser getParser()Returns the XML pull parser to use.- Since:
- 1.5
-
getInputStream
Returns the input stream to read.- Since:
- 1.5
-
getFeedClass
Returns the feed class to parse.- Since:
- 1.5
-
getNamespaceDictionary
Returns the XML namespace dictionary.- Since:
- 1.5
-
parseFeed
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
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
Closes the underlying parser.- Throws:
IOException
-
parseEntryInternal
protected abstract Object parseEntryInternal() throws IOException, org.xmlpull.v1.XmlPullParserExceptionParses a single entry.- Returns:
- object representing the entry
- Throws:
IOException
- I/O exceptionorg.xmlpull.v1.XmlPullParserException
- XML pull parser exception
-