wirefeedoutput.html

rsslibj-1_0RC2,RSS阅读

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="getSupportedFeedTypes()"><!-- --></A><H3>
getSupportedFeedTypes</H3>
<PRE>
public static java.util.List <B>getSupportedFeedTypes</B>()</PRE>
<DL>
<DD>Returns the list of supported output feed types.
 <p>
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a list of String elements with the supported output feed types.<DT><B>See Also:</B><DD><A HREF="../../../../com/sun/syndication/feed/WireFeed.html" title="class in com.sun.syndication.feed"><CODE>for details on the format of these strings.
 <p></CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="outputString(com.sun.syndication.feed.WireFeed)"><!-- --></A><H3>
outputString</H3>
<PRE>
public java.lang.String <B>outputString</B>(<A HREF="../../../../com/sun/syndication/feed/WireFeed.html" title="class in com.sun.syndication.feed">WireFeed</A>&nbsp;feed)
                              throws java.lang.IllegalArgumentException,
                                     <A HREF="../../../../com/sun/syndication/io/FeedException.html" title="class in com.sun.syndication.io">FeedException</A></PRE>
<DL>
<DD>Creates a String with the XML representation for the given WireFeed.
 <p>
 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.
 <p>
 NOTE: This method delages to the 'Document WireFeedOutput#outputJDom(WireFeed)'.
 <p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>feed</CODE> - Abstract feed to create XML representation from. The type of the WireFeed must match
        the type given to the FeedOuptut constructor.
<DT><B>Returns:</B><DD>a String with the XML representation for the given WireFeed.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - thrown if the feed type of the WireFeedOutput and WireFeed don't match.
<DD><CODE><A HREF="../../../../com/sun/syndication/io/FeedException.html" title="class in com.sun.syndication.io">FeedException</A></CODE> - thrown if the XML representation for the feed could not be created.</DL>
</DD>
</DL>
<HR>

<A NAME="output(com.sun.syndication.feed.WireFeed, java.io.File)"><!-- --></A><H3>
output</H3>
<PRE>
public void <B>output</B>(<A HREF="../../../../com/sun/syndication/feed/WireFeed.html" title="class in com.sun.syndication.feed">WireFeed</A>&nbsp;feed,
                   java.io.File&nbsp;file)
            throws java.lang.IllegalArgumentException,
                   java.io.IOException,
                   <A HREF="../../../../com/sun/syndication/io/FeedException.html" title="class in com.sun.syndication.io">FeedException</A></PRE>
<DL>
<DD>Creates a File containing with the XML representation for the given WireFeed.
 <p>
 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.
 <p>
 NOTE: This method delages to the 'Document WireFeedOutput#outputJDom(WireFeed)'.
 <p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>feed</CODE> - Abstract feed to create XML representation from. The type of the WireFeed must match
        the type given to the FeedOuptut constructor.<DD><CODE>file</CODE> - the file where to write the XML representation for the given WireFeed.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - thrown if the feed type of the WireFeedOutput and WireFeed don't match.
<DD><CODE>java.io.IOException</CODE> - thrown if there was some problem writing to the File.
<DD><CODE><A HREF="../../../../com/sun/syndication/io/FeedException.html" title="class in com.sun.syndication.io">FeedException</A></CODE> - thrown if the XML representation for the feed could not be created.</DL>
</DD>
</DL>
<HR>

<A NAME="output(com.sun.syndication.feed.WireFeed, java.io.Writer)"><!-- --></A><H3>
output</H3>
<PRE>
public void <B>output</B>(<A HREF="../../../../com/sun/syndication/feed/WireFeed.html" title="class in com.sun.syndication.feed">WireFeed</A>&nbsp;feed,
                   java.io.Writer&nbsp;writer)
            throws java.lang.IllegalArgumentException,
                   java.io.IOException,
                   <A HREF="../../../../com/sun/syndication/io/FeedException.html" title="class in com.sun.syndication.io">FeedException</A></PRE>
<DL>
<DD>Writes to an Writer the XML representation for the given WireFeed.
 <p>
 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.
 <p>
 NOTE: This method delages to the 'Document WireFeedOutput#outputJDom(WireFeed)'.
 <p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>feed</CODE> - Abstract feed to create XML representation from. The type of the WireFeed must match
        the type given to the FeedOuptut constructor.<DD><CODE>writer</CODE> - Writer to write the XML representation for the given WireFeed.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - thrown if the feed type of the WireFeedOutput and WireFeed don't match.
<DD><CODE>java.io.IOException</CODE> - thrown if there was some problem writing to the Writer.
<DD><CODE><A HREF="../../../../com/sun/syndication/io/FeedException.html" title="class in com.sun.syndication.io">FeedException</A></CODE> - thrown if the XML representation for the feed could not be created.</DL>
</DD>
</DL>
<HR>

<A NAME="outputW3CDom(com.sun.syndication.feed.WireFeed)"><!-- --></A><H3>
outputW3CDom</H3>
<PRE>
public org.w3c.dom.Document <B>outputW3CDom</B>(<A HREF="../../../../com/sun/syndication/feed/WireFeed.html" title="class in com.sun.syndication.feed">WireFeed</A>&nbsp;feed)
                                  throws java.lang.IllegalArgumentException,
                                         <A HREF="../../../../com/sun/syndication/io/FeedException.html" title="class in com.sun.syndication.io">FeedException</A></PRE>
<DL>
<DD>Creates a W3C DOM document for the given WireFeed.
 <p>
 This method does not use the feed encoding property.
 <p>
 NOTE: This method delages to the 'Document WireFeedOutput#outputJDom(WireFeed)'.
 <p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>feed</CODE> - Abstract feed to create W3C DOM document from. The type of the WireFeed must match
        the type given to the FeedOuptut constructor.
<DT><B>Returns:</B><DD>the W3C DOM document for the given WireFeed.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - thrown if the feed type of the WireFeedOutput and WireFeed don't match.
<DD><CODE><A HREF="../../../../com/sun/syndication/io/FeedException.html" title="class in com.sun.syndication.io">FeedException</A></CODE> - thrown if the W3C DOM document for the feed could not be created.</DL>
</DD>
</DL>
<HR>

<A NAME="outputJDom(com.sun.syndication.feed.WireFeed)"><!-- --></A><H3>
outputJDom</H3>
<PRE>
public org.jdom.Document <B>outputJDom</B>(<A HREF="../../../../com/sun/syndication/feed/WireFeed.html" title="class in com.sun.syndication.feed">WireFeed</A>&nbsp;feed)
                             throws java.lang.IllegalArgumentException,
                                    <A HREF="../../../../com/sun/syndication/io/FeedException.html" title="class in com.sun.syndication.io">FeedException</A></PRE>
<DL>
<DD>Creates a JDOM document for the given WireFeed.
 <p>
 This method does not use the feed encoding property.
 <p>
 NOTE: All other output methods delegate to this method.
 <p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>feed</CODE> - Abstract feed to create JDOM document from. The type of the WireFeed must match
        the type given to the FeedOuptut constructor.
<DT><B>Returns:</B><DD>the JDOM document for the given WireFeed.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - thrown if the feed type of the WireFeedOutput and WireFeed don't match.
<DD><CODE><A HREF="../../../../com/sun/syndication/io/FeedException.html" title="class in com.sun.syndication.io">FeedException</A></CODE> - thrown if the JDOM document for the feed could not be created.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/WireFeedOutput.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../com/sun/syndication/io/WireFeedInput.html" title="class in com.sun.syndication.io"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../com/sun/syndication/io/WireFeedParser.html" title="interface in com.sun.syndication.io"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?com/sun/syndication/io/WireFeedOutput.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="WireFeedOutput.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
Copyright &copy; 2004-2008 Sun Microsystems. All Rights Reserved.
</BODY>
</HTML>