com.sun.syndication.io

Class SyndFeedOutput

public class SyndFeedOutput extends Object

Generates an XML document (String, File, OutputStream, Writer, W3C DOM document or JDOM document) out of an SyndFeedImpl..

It delegates to a WireFeedOutput to generate all feed types.

Author: Alejandro Abdelnur

Field Summary
WireFeedOutput_feedOutput
Constructor Summary
SyndFeedOutput()
Creates a SyndFeedOutput instance.
Method Summary
voidoutput(SyndFeed feed, File file)
Creates a File containing with the XML representation for the given SyndFeedImpl.
voidoutput(SyndFeed feed, Writer writer)
Writes to an Writer the XML representation for the given SyndFeedImpl.
DocumentoutputJDom(SyndFeed feed)
Creates a JDOM document for the given SyndFeedImpl.
StringoutputString(SyndFeed feed)
Creates a String with the XML representation for the given SyndFeedImpl.
DocumentoutputW3CDom(SyndFeed feed)
Creates a W3C DOM document for the given SyndFeedImpl.

Field Detail

_feedOutput

private WireFeedOutput _feedOutput

Constructor Detail

SyndFeedOutput

public SyndFeedOutput()
Creates a SyndFeedOutput instance.

Method Detail

output

public void output(SyndFeed feed, File file)
Creates a File containing with the XML representation for the given SyndFeedImpl.

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.

Parameters: feed Abstract feed to create XML representation from. The type of the SyndFeedImpl must match the type given to the FeedOuptut constructor. file the file where to write the XML representation for the given SyndFeedImpl.

Throws: IOException thrown if there was some problem writing to the File. FeedException thrown if the XML representation for the feed could not be created.

output

public void output(SyndFeed feed, Writer writer)
Writes to an Writer the XML representation for the given SyndFeedImpl.

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.

Parameters: feed Abstract feed to create XML representation from. The type of the SyndFeedImpl must match the type given to the FeedOuptut constructor. writer Writer to write the XML representation for the given SyndFeedImpl.

Throws: IOException thrown if there was some problem writing to the Writer. FeedException thrown if the XML representation for the feed could not be created.

outputJDom

public Document outputJDom(SyndFeed feed)
Creates a JDOM document for the given SyndFeedImpl.

This method does not use the feed encoding property.

Parameters: feed Abstract feed to create JDOM document from. The type of the SyndFeedImpl must match the type given to the FeedOuptut constructor.

Returns: the JDOM document for the given SyndFeedImpl.

Throws: FeedException thrown if the JDOM document for the feed could not be created.

outputString

public String outputString(SyndFeed feed)
Creates a String with the XML representation for the given SyndFeedImpl.

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.

Parameters: feed Abstract feed to create XML representation from. The type of the SyndFeedImpl must match the type given to the FeedOuptut constructor.

Returns: a String with the XML representation for the given SyndFeedImpl.

Throws: FeedException thrown if the XML representation for the feed could not be created.

outputW3CDom

public Document outputW3CDom(SyndFeed feed)
Creates a W3C DOM document for the given SyndFeedImpl.

This method does not use the feed encoding property.

Parameters: feed Abstract feed to create W3C DOM document from. The type of the SyndFeedImpl must match the type given to the FeedOuptut constructor.

Returns: the W3C DOM document for the given SyndFeedImpl.

Throws: FeedException thrown if the W3C DOM document for the feed could not be created.

Copyright © Sun Microsystems. All Rights Reserved.