com.sun.syndication.io

Class SyndFeedInput

public class SyndFeedInput extends Object

Parses an XML document (File, InputStream, Reader, W3C SAX InputSource, W3C DOM Document or JDom DOcument) into an SyndFeedImpl.

It delegates to a WireFeedInput to handle all feed types.

Author: Alejandro Abdelnur

Field Summary
WireFeedInput_feedInput
Constructor Summary
SyndFeedInput()
Creates a SyndFeedInput instance with input validation turned off.
SyndFeedInput(boolean validate)
Creates a SyndFeedInput instance.
Method Summary
SyndFeedbuild(File file)
Builds SyndFeedImpl from a file.
SyndFeedbuild(Reader reader)
Builds SyndFeedImpl from an Reader.
SyndFeedbuild(InputSource is)
Builds SyndFeedImpl from an W3C SAX InputSource.
SyndFeedbuild(Document document)
Builds SyndFeedImpl from an W3C DOM document.
SyndFeedbuild(Document document)
Builds SyndFeedImpl from an JDOM document.
booleangetXmlHealerOn()
Indicates if the WiredFeedInput instance will XML heal (if necessary) the character stream.
voidsetXmlHealerOn(boolean heals)
Enables XML healing in the WiredFeedInput instance.

Field Detail

_feedInput

private WireFeedInput _feedInput

Constructor Detail

SyndFeedInput

public SyndFeedInput()
Creates a SyndFeedInput instance with input validation turned off.

SyndFeedInput

public SyndFeedInput(boolean validate)
Creates a SyndFeedInput instance.

Parameters: validate indicates if the input should be validated. NOT IMPLEMENTED YET (validation does not happen)

Method Detail

build

public SyndFeed build(File file)
Builds SyndFeedImpl from a file.

Parameters: file file to read to create the SyndFeedImpl.

Returns: the SyndFeedImpl 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

build

public SyndFeed build(Reader reader)
Builds SyndFeedImpl from an Reader.

Parameters: reader Reader to read to create the SyndFeedImpl.

Returns: the SyndFeedImpl 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

build

public SyndFeed build(InputSource is)
Builds SyndFeedImpl from an W3C SAX InputSource.

Parameters: is W3C SAX InputSource to read to create the SyndFeedImpl.

Returns: the SyndFeedImpl 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

build

public SyndFeed build(Document document)
Builds SyndFeedImpl from an W3C DOM document.

Parameters: document W3C DOM document to read to create the SyndFeedImpl.

Returns: the SyndFeedImpl 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

build

public SyndFeed build(Document document)
Builds SyndFeedImpl from an JDOM document.

Parameters: document JDOM document to read to create the SyndFeedImpl.

Returns: the SyndFeedImpl 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

getXmlHealerOn

public boolean getXmlHealerOn()
Indicates if the WiredFeedInput instance will XML heal (if necessary) the character stream.

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.

setXmlHealerOn

public void setXmlHealerOn(boolean heals)
Enables XML healing in the WiredFeedInput instance.

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.

Copyright © Sun Microsystems. All Rights Reserved.