com.sun.syndication.io
public class WireFeedOutput extends Object
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 | |
---|---|
static FeedGenerators | GENERATORS |
Constructor Summary | |
---|---|
WireFeedOutput()
Creates a FeedOuput instance.
|
Method Summary | |
---|---|
static List | getSupportedFeedTypes()
Returns the list of supported output feed types.
|
void | output(WireFeed feed, File file)
Creates a File containing with the XML representation for the given WireFeed.
|
void | output(WireFeed feed, Writer writer)
Writes to an Writer the XML representation for the given WireFeed.
|
Document | outputJDom(WireFeed feed)
Creates a JDOM document for the given WireFeed.
|
String | outputString(WireFeed feed)
Creates a String with the XML representation for the given WireFeed.
|
Document | outputW3CDom(WireFeed feed)
Creates a W3C DOM document for the given WireFeed.
|
Returns: a list of String elements with the supported output feed types.
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)'.
Parameters: feed Abstract feed to create XML representation from. The type of the WireFeed must match the type given to the FeedOuptut constructor. file the file where to write the XML representation for the given WireFeed.
Throws: IllegalArgumentException thrown if the feed type of the WireFeedOutput and WireFeed don't match. IOException thrown if there was some problem writing to the File. FeedException thrown if the XML representation for the feed could not be created.
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)'.
Parameters: feed Abstract feed to create XML representation from. The type of the WireFeed must match the type given to the FeedOuptut constructor. writer Writer to write the XML representation for the given WireFeed.
Throws: IllegalArgumentException thrown if the feed type of the WireFeedOutput and WireFeed don't match. IOException thrown if there was some problem writing to the Writer. FeedException thrown if the XML representation for the feed could not be created.
This method does not use the feed encoding property.
NOTE: All other output methods delegate to this method.
Parameters: feed Abstract feed to create JDOM document from. The type of the WireFeed must match the type given to the FeedOuptut constructor.
Returns: the JDOM document for the given WireFeed.
Throws: IllegalArgumentException thrown if the feed type of the WireFeedOutput and WireFeed don't match. FeedException thrown if the JDOM document for the feed could not be created.
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)'.
Parameters: feed Abstract feed to create XML representation from. The type of the WireFeed must match the type given to the FeedOuptut constructor.
Returns: a String with the XML representation for the given WireFeed.
Throws: IllegalArgumentException thrown if the feed type of the WireFeedOutput and WireFeed don't match. FeedException thrown if the XML representation for the feed could not be created.
This method does not use the feed encoding property.
NOTE: This method delages to the 'Document WireFeedOutput#outputJDom(WireFeed)'.
Parameters: feed Abstract feed to create W3C DOM document from. The type of the WireFeed must match the type given to the FeedOuptut constructor.
Returns: the W3C DOM document for the given WireFeed.
Throws: IllegalArgumentException thrown if the feed type of the WireFeedOutput and WireFeed don't match. FeedException thrown if the W3C DOM document for the feed could not be created.