Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> sun >> syndication >> [ io overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.sun.syndication.io
Class WireFeedInput  

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

---

public class WireFeedInput

extends java.lang.Object

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

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
private static class	WireFeedInput.EmptyEntityResolver

 

Field Summary
private  boolean	_validate
private  boolean	_xmlHealerOn
private static org.xml.sax.InputSource	EMPTY_INPUTSOURCE
private static com.sun.syndication.io.impl.FeedParsers	FEED_PARSERS
private static org.xml.sax.EntityResolver	RESOLVER

 

Constructor Summary

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

WireFeedInput(boolean validate)           Creates a WireFeedInput instance.

 

Method Summary
com.sun.syndication.feed.WireFeed	build(org.w3c.dom.Document document)           Builds an WireFeed (RSS or Atom) from an W3C DOM document.
com.sun.syndication.feed.WireFeed	build(org.jdom.Document document)           Builds an WireFeed (RSS or Atom) from an JDOM document.
com.sun.syndication.feed.WireFeed	build(java.io.File file)           Builds an WireFeed (RSS or Atom) from a file.
com.sun.syndication.feed.WireFeed	build(org.xml.sax.InputSource is)           Builds an WireFeed (RSS or Atom) from an W3C SAX InputSource.
com.sun.syndication.feed.WireFeed	build(java.io.Reader reader)           Builds an WireFeed (RSS or Atom) from an Reader.
static java.util.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.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

FEED_PARSERS

private static com.sun.syndication.io.impl.FeedParsers FEED_PARSERS

---

EMPTY_INPUTSOURCE

private static final org.xml.sax.InputSource EMPTY_INPUTSOURCE

---

RESOLVER

private static final org.xml.sax.EntityResolver RESOLVER

---

_validate

private boolean _validate

---

_xmlHealerOn

private boolean _xmlHealerOn

Constructor Detail

WireFeedInput

public WireFeedInput()

Creates a WireFeedInput instance with input validation turned off.

---

WireFeedInput

public WireFeedInput(boolean validate)

Creates a WireFeedInput instance.

Method Detail

getSupportedFeedTypes

public static java.util.List getSupportedFeedTypes()

Returns the list of supported input feed types.

---

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.

---

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.

---

build

public com.sun.syndication.feed.WireFeed build(java.io.File file)
                                        throws java.io.FileNotFoundException,
                                               java.io.IOException,
                                               java.lang.IllegalArgumentException,
                                               FeedException

Builds an WireFeed (RSS or Atom) from a file.

NOTE: This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom.Document)'.

---

build

public com.sun.syndication.feed.WireFeed build(java.io.Reader reader)
                                        throws java.lang.IllegalArgumentException,
                                               FeedException

Builds an WireFeed (RSS or Atom) from an Reader.

NOTE: This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom.Document)'.

---

build

public com.sun.syndication.feed.WireFeed build(org.xml.sax.InputSource is)
                                        throws java.lang.IllegalArgumentException,
                                               FeedException

Builds an WireFeed (RSS or Atom) from an W3C SAX InputSource.

NOTE: This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom.Document)'.

---

build

public com.sun.syndication.feed.WireFeed build(org.w3c.dom.Document document)
                                        throws java.lang.IllegalArgumentException,
                                               FeedException

Builds an WireFeed (RSS or Atom) from an W3C DOM document.

NOTE: This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom.Document)'.

---

build

public com.sun.syndication.feed.WireFeed build(org.jdom.Document document)
                                        throws java.lang.IllegalArgumentException,
                                               FeedException

Builds an WireFeed (RSS or Atom) from an JDOM document.

NOTE: All other build methods delegate to this method.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> sun >> syndication >> [ io overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---