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 WireFeedOutput  

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

---

public class WireFeedOutput

extends java.lang.Object

Generates an XML document (String, File, OutputStream, Writer, W3C DOM document or JDOM document) out of an WireFeed (RSS/Atom).

It generates all flavors of RSS (0.90, 0.91, 0.92, 0.93, 0.94, 1.0 and 2.0) and Atom 0.3 feeds. Generators are plugable (they must implement the ModuleParser interface).

---

Field Summary
private static com.sun.syndication.io.impl.FeedGenerators	GENERATORS

 

Constructor Summary

WireFeedOutput()           Creates a FeedOuput instance.

 

Method Summary
static java.util.List	getSupportedFeedTypes()           Returns the list of supported output feed types.
void	output(com.sun.syndication.feed.WireFeed feed, java.io.File file)           Creates a File containing with the XML representation for the given WireFeed.
void	output(com.sun.syndication.feed.WireFeed feed, java.io.Writer writer)           Writes to an Writer the XML representation for the given WireFeed.
org.jdom.Document	outputJDom(com.sun.syndication.feed.WireFeed feed)           Creates a JDOM document for the given WireFeed.
java.lang.String	outputString(com.sun.syndication.feed.WireFeed feed)           Creates a String with the XML representation for the given WireFeed.
org.w3c.dom.Document	outputW3CDom(com.sun.syndication.feed.WireFeed feed)           Creates a W3C DOM document for the given WireFeed.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

GENERATORS

private static final com.sun.syndication.io.impl.FeedGenerators GENERATORS

Constructor Detail

WireFeedOutput

public WireFeedOutput()

Creates a FeedOuput instance.

Method Detail

getSupportedFeedTypes

public static java.util.List getSupportedFeedTypes()

Returns the list of supported output feed types.

---

outputString

public java.lang.String outputString(com.sun.syndication.feed.WireFeed feed)
                              throws java.lang.IllegalArgumentException,
                                     FeedException

Creates a String with the XML representation for the given WireFeed.

If the feed encoding is not NULL, it will be used in the XML prolog encoding attribute. It is the responsibility of the developer to ensure that if the String is written to a character stream the stream charset is the same as the feed encoding property.

NOTE: This method delages to the 'Document WireFeedOutput#outputJDom(WireFeed)'.

---

output

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

Creates a File containing with the XML representation for the given WireFeed.

If the feed encoding is not NULL, it will be used in the XML prolog encoding attribute. The platform default charset encoding is used to write the feed to the file. It is the responsibility of the developer to ensure the feed encoding is set to the platform charset encoding.

NOTE: This method delages to the 'Document WireFeedOutput#outputJDom(WireFeed)'.

---

output

public void output(com.sun.syndication.feed.WireFeed feed,
                   java.io.Writer writer)
            throws java.lang.IllegalArgumentException,
                   java.io.IOException,
                   FeedException

Writes to an Writer the XML representation for the given WireFeed.

If the feed encoding is not NULL, it will be used in the XML prolog encoding attribute. It is the responsibility of the developer to ensure the Writer instance is using the same charset encoding.

NOTE: This method delages to the 'Document WireFeedOutput#outputJDom(WireFeed)'.

---

outputW3CDom

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

Creates a W3C DOM document for the given WireFeed.

This method does not use the feed encoding property.

NOTE: This method delages to the 'Document WireFeedOutput#outputJDom(WireFeed)'.

---

outputJDom

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

Creates a JDOM document for the given WireFeed.

This method does not use the feed encoding property.

NOTE: All other output 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

---