com.sun.syndication.io
Interface WireFeedParser

public interface WireFeedParser

Parses an XML document (JDOM) into a feed bean.

WireFeedParser instances must thread safe.

TODO: explain how developers can plugin their own implementations.

Author:

Alejandro Abdelnur

Method Summary

java.lang.String	getType() Returns the type of feed the parser handles.
boolean	isMyType(org.jdom.Document document) Inspects an XML Document (JDOM) to check if it can parse it.
WireFeed	parse(org.jdom.Document document, boolean validate) Parses an XML document (JDOM Document) into a feed bean.

Method Detail

getType

java.lang.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.jdom.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.jdom.Document document,
               boolean validate)
               throws java.lang.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:

java.lang.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).