Package com.rometools.rome.io
Interface WireFeedParser
-
- All Known Implementing Classes:
Atom03Parser,Atom10Parser,BaseWireFeedParser,RSS090Parser,RSS091NetscapeParser,RSS091UserlandParser,RSS092Parser,RSS093Parser,RSS094Parser,RSS10Parser,RSS20Parser,RSS20wNSParser
public interface WireFeedParserParses an XML document (JDOM) into a feed bean.WireFeedParser instances must thread safe.
TODO: explain how developers can plugin their own implementations.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetType()Returns the type of feed the parser handles.booleanisMyType(org.jdom2.Document document)Inspects an XML Document (JDOM) to check if it can parse it.WireFeedparse(org.jdom2.Document document, boolean validate, Locale locale)Parses an XML document (JDOM Document) into a feed bean.
-
-
-
Method Detail
-
getType
String getType()
Returns the type of feed the parser handles.- Returns:
- the type of feed the parser handles.
- See Also:
for details on the format of this string.
-
isMyType
boolean isMyType(org.jdom2.Document document)
Inspects an XML Document (JDOM) to check if it can parse it.It checks if the given document if the type of feeds the parser understands.
- Parameters:
document- XML Document (JDOM) to check if it can be parsed by this parser.- Returns:
- true if the parser know how to parser this feed, false otherwise.
-
parse
WireFeed parse(org.jdom2.Document document, boolean validate, Locale locale) throws IllegalArgumentException, FeedException
Parses an XML document (JDOM Document) into a feed bean.- Parameters:
document- XML document (JDOM) to parse.validate- indicates if the feed should be strictly validated (NOT YET IMPLEMENTED).- Returns:
- the resulting feed bean.
- Throws:
IllegalArgumentException- thrown if the parser cannot handle the given feed type.FeedException- thrown if a feed bean cannot be created out of the XML document (JDOM).
-
-