com.sun.syndication.io
public class WireFeedInput extends Object
It accepts all flavors of RSS (0.90, 0.91, 0.92, 0.93, 0.94, 1.0 and 2.0) and Atom 0.3 feeds. Parsers are plugable (they must implement the WireFeedParser interface).
The WireFeedInput useds liberal parsers.
Nested Class Summary | |
---|---|
static class | WireFeedInput.EmptyEntityResolver |
Field Summary | |
---|---|
static InputSource | EMPTY_INPUTSOURCE |
static FeedParsers | FEED_PARSERS |
static EntityResolver | RESOLVER |
boolean | _validate |
boolean | _xmlHealerOn |
Constructor Summary | |
---|---|
WireFeedInput()
Creates a WireFeedInput instance with input validation turned off.
| |
WireFeedInput(boolean validate)
Creates a WireFeedInput instance.
|
Method Summary | |
---|---|
WireFeed | build(File file)
Builds an WireFeed (RSS or Atom) from a file.
|
WireFeed | build(Reader reader)
Builds an WireFeed (RSS or Atom) from an Reader.
|
WireFeed | build(InputSource is)
Builds an WireFeed (RSS or Atom) from an W3C SAX InputSource.
|
WireFeed | build(Document document)
Builds an WireFeed (RSS or Atom) from an W3C DOM document.
|
WireFeed | build(Document document)
Builds an WireFeed (RSS or Atom) from an JDOM document.
|
protected SAXBuilder | createSAXBuilder()
Creates and sets up a org.jdom.input.SAXBuilder for parsing.
|
static List | getSupportedFeedTypes()
Returns the list of supported input feed types.
|
boolean | getXmlHealerOn()
Indicates if the WiredFeedInput instance will XML heal (if necessary) the character stream.
|
void | setXmlHealerOn(boolean heals)
Enables XML healing in the WiredFeedInput instance.
|
Parameters: validate indicates if the input should be validated. NOT IMPLEMENTED YET (validation does not happen)
NOTE: This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom.Document)'.
Parameters: file file to read to create the WireFeed.
Returns: the WireFeed read from the file.
Throws: FileNotFoundException thrown if the file could not be found. IOException thrown if there is problem reading the file. IllegalArgumentException thrown if feed type could not be understood by any of the underlying parsers. FeedException if the feed could not be parsed
NOTE: This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom.Document)'.
Parameters: reader Reader to read to create the WireFeed.
Returns: the WireFeed read from the Reader.
Throws: IllegalArgumentException thrown if feed type could not be understood by any of the underlying parsers. FeedException if the feed could not be parsed
NOTE: This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom.Document)'.
Parameters: is W3C SAX InputSource to read to create the WireFeed.
Returns: the WireFeed read from the W3C SAX InputSource.
Throws: IllegalArgumentException thrown if feed type could not be understood by any of the underlying parsers. FeedException if the feed could not be parsed
NOTE: This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom.Document)'.
Parameters: document W3C DOM document to read to create the WireFeed.
Returns: the WireFeed read from the W3C DOM document.
Throws: IllegalArgumentException thrown if feed type could not be understood by any of the underlying parsers. FeedException if the feed could not be parsed
NOTE: All other build methods delegate to this method.
Parameters: document JDOM document to read to create the WireFeed.
Returns: the WireFeed read from the JDOM document.
Throws: IllegalArgumentException thrown if feed type could not be understood by any of the underlying parsers. FeedException if the feed could not be parsed
Returns: a new org.jdom.input.SAXBuilder object
Returns: a list of String elements with the supported input feed types.
Healing trims leading chars from the stream (empty spaces and comments) until the XML prolog.
Healing resolves HTML entities (from literal to code number) in the reader.
The healing is done only with the build(File) and build(Reader) signatures.
By default is TRUE.
Returns: TRUE if healing is enabled, FALSE if not.
Healing trims leading chars from the stream (empty spaces and comments) until the XML prolog.
Healing resolves HTML entities (from literal to code number) in the reader.
The healing is done only with the build(File) and build(Reader) signatures.
By default is TRUE.
Parameters: heals TRUE enables stream healing, FALSE disables it.