com.sun.syndication.io
クラス SyndFeedInput

java.lang.Object
  com.sun.syndication.io.SyndFeedInput

public class SyndFeedInput
extends java.lang.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.

コンストラクタの概要

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

SyndFeedInput(boolean validate)
Creates a SyndFeedInput instance.

メソッドの概要

SyndFeed	build(org.w3c.dom.Document document) Builds SyndFeedImpl from an W3C DOM document.
SyndFeed	build(java.io.File file) Builds SyndFeedImpl from a file.
SyndFeed	build(org.xml.sax.InputSource is) Builds SyndFeedImpl from an W3C SAX InputSource.
SyndFeed	build(java.io.Reader reader) Builds SyndFeedImpl from an Reader.
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.

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

SyndFeedInput

public SyndFeedInput()

Creates a SyndFeedInput instance with input validation turned off.

SyndFeedInput

public SyndFeedInput(boolean validate)

Creates a SyndFeedInput instance.

パラメータ:

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

メソッドの詳細

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.

パラメータ:

heals - TRUE enables stream healing, FALSE disables it.

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.

戻り値:

TRUE if healing is enabled, FALSE if not.

build

public SyndFeed build(java.io.File file)
               throws java.io.FileNotFoundException,
                      java.io.IOException,
                      java.lang.IllegalArgumentException,
                      FeedException

Builds SyndFeedImpl from a file.

パラメータ:

file - file to read to create the SyndFeedImpl.

戻り値:

the SyndFeedImpl read from the file.

例外:

java.io.FileNotFoundException - thrown if the file could not be found.

java.io.IOException - thrown if there is problem reading the file.

java.lang.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(java.io.Reader reader)
               throws java.lang.IllegalArgumentException,
                      FeedException

Builds SyndFeedImpl from an Reader.

パラメータ:

reader - Reader to read to create the SyndFeedImpl.

戻り値:

the SyndFeedImpl read from the Reader.

例外:

java.lang.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(org.xml.sax.InputSource is)
               throws java.lang.IllegalArgumentException,
                      FeedException

Builds SyndFeedImpl from an W3C SAX InputSource.

パラメータ:

is - W3C SAX InputSource to read to create the SyndFeedImpl.

戻り値:

the SyndFeedImpl read from the W3C SAX InputSource.

例外:

java.lang.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(org.w3c.dom.Document document)
               throws java.lang.IllegalArgumentException,
                      FeedException

Builds SyndFeedImpl from an W3C DOM document.

パラメータ:

document - W3C DOM document to read to create the SyndFeedImpl.

戻り値:

the SyndFeedImpl read from the W3C DOM document.

例外:

java.lang.IllegalArgumentException - thrown if feed type could not be understood by any of the underlying parsers.

FeedException - if the feed could not be parsed