com.sun.syndication.io
Class SyndFeedOutput

java.lang.Object
  extended bycom.sun.syndication.io.SyndFeedOutput

public class SyndFeedOutput
extends java.lang.Object

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

It delegates to a WireFeedOutput to generate all feed types.

Author:
Alejandro Abdelnur

Constructor Summary
SyndFeedOutput()
          Creates a SyndFeedOutput instance.
 
Method Summary
 void output(SyndFeedI feed, java.io.File file)
          Creates a File containing with the XML representation for the given SyndFeed.
 void output(SyndFeedI feed, java.io.Writer writer)
          Writes to an Writer the XML representation for the given SyndFeed.
 org.jdom.Document outputJDom(SyndFeedI feed)
          Creates a JDOM document for the given SyndFeed.
 java.lang.String outputString(SyndFeedI feed)
          Creates a String with the XML representation for the given SyndFeed.
 org.w3c.dom.Document outputW3CDom(SyndFeedI feed)
          Creates a W3C DOM document for the given SyndFeed.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SyndFeedOutput

public SyndFeedOutput()
Creates a SyndFeedOutput instance.

Method Detail

outputString

public java.lang.String outputString(SyndFeedI feed)
                              throws FeedException
Creates a String with the XML representation for the given SyndFeed.

Parameters:
feed - Abstract feed to create XML representation from. The type of the SyndFeed must match the type given to the FeedOuptut constructor.
Returns:
a String with the XML representation for the given SyndFeed.
Throws:
FeedException - thrown if the XML representation for the feed could not be created.

output

public void output(SyndFeedI feed,
                   java.io.File file)
            throws java.io.IOException,
                   FeedException
Creates a File containing with the XML representation for the given SyndFeed.

Parameters:
feed - Abstract feed to create XML representation from. The type of the SyndFeed must match the type given to the FeedOuptut constructor.
file - the file where to write the XML representation for the given SyndFeed.
Throws:
java.io.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(SyndFeedI feed,
                   java.io.Writer writer)
            throws java.io.IOException,
                   FeedException
Writes to an Writer the XML representation for the given SyndFeed.

Parameters:
feed - Abstract feed to create XML representation from. The type of the SyndFeed must match the type given to the FeedOuptut constructor.
writer - Writer to write the XML representation for the given SyndFeed.
Throws:
java.io.IOException - thrown if there was some problem writing to the Writer.
FeedException - thrown if the XML representation for the feed could not be created.

outputW3CDom

public org.w3c.dom.Document outputW3CDom(SyndFeedI feed)
                                  throws FeedException
Creates a W3C DOM document for the given SyndFeed.

Parameters:
feed - Abstract feed to create W3C DOM document from. The type of the SyndFeed must match the type given to the FeedOuptut constructor.
Returns:
the W3C DOM document for the given SyndFeed.
Throws:
FeedException - thrown if the W3C DOM document for the feed could not be created.

outputJDom

public org.jdom.Document outputJDom(SyndFeedI feed)
                             throws FeedException
Creates a JDOM document for the given SyndFeed.

Parameters:
feed - Abstract feed to create JDOM document from. The type of the SyndFeed must match the type given to the FeedOuptut constructor.
Returns:
the JDOM document for the given SyndFeed.
Throws:
FeedException - thrown if the JDOM document for the feed could not be created.


Copyright © 2004 Sun Microsystems. All Rights Reserved.