wirefeedinput.html

rsslibj-1_0RC2,RSS阅读

<DT><B>Parameters:</B><DD><CODE>validate</CODE> - indicates if the input should be validated. NOT IMPLEMENTED YET (validation does not happen)</DL>
</DL>

<!-- ============ 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 input feed types.
 <p>
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a list of String elements with the supported input 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="setXmlHealerOn(boolean)"><!-- --></A><H3>
setXmlHealerOn</H3>
<PRE>
public void <B>setXmlHealerOn</B>(boolean&nbsp;heals)</PRE>
<DL>
<DD>Enables XML healing in the WiredFeedInput instance.
 <p>
 Healing trims leading chars from the stream (empty spaces and comments) until the XML prolog.
 <p>
 Healing resolves HTML entities (from literal to code number) in the reader.
 <p>
 The healing is done only with the build(File) and build(Reader) signatures.
 <p>
 By default is TRUE.
 <p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>heals</CODE> - TRUE enables stream healing, FALSE disables it.</DL>
</DD>
</DL>
<HR>

<A NAME="getXmlHealerOn()"><!-- --></A><H3>
getXmlHealerOn</H3>
<PRE>
public boolean <B>getXmlHealerOn</B>()</PRE>
<DL>
<DD>Indicates if the WiredFeedInput instance will XML heal (if necessary) the character stream.
 <p>
 Healing trims leading chars from the stream (empty spaces and comments) until the XML prolog.
 <p>
 Healing resolves HTML entities (from literal to code number) in the reader.
 <p>
 The healing is done only with the build(File) and build(Reader) signatures.
 <p>
 By default is TRUE.
 <p>
<P>
<DD><DL>

<DT><B>Returns:</B><DD>TRUE if healing is enabled, FALSE if not.</DL>
</DD>
</DL>
<HR>

<A NAME="build(java.io.File)"><!-- --></A><H3>
build</H3>
<PRE>
public <A HREF="../../../../com/sun/syndication/feed/WireFeed.html" title="class in com.sun.syndication.feed">WireFeed</A> <B>build</B>(java.io.File&nbsp;file)
               throws java.io.FileNotFoundException,
                      java.io.IOException,
                      java.lang.IllegalArgumentException,
                      <A HREF="../../../../com/sun/syndication/io/FeedException.html" title="class in com.sun.syndication.io">FeedException</A></PRE>
<DL>
<DD>Builds an WireFeed (RSS or Atom) from a file.
 <p>
 NOTE: This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom.Document)'.
 <p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - file to read to create the WireFeed.
<DT><B>Returns:</B><DD>the WireFeed read from the file.
<DT><B>Throws:</B>
<DD><CODE>java.io.FileNotFoundException</CODE> - thrown if the file could not be found.
<DD><CODE>java.io.IOException</CODE> - thrown if there is problem reading the file.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - thrown if feed type could not be understood by any of the underlying parsers.
<DD><CODE><A HREF="../../../../com/sun/syndication/io/FeedException.html" title="class in com.sun.syndication.io">FeedException</A></CODE> - if the feed could not be parsed</DL>
</DD>
</DL>
<HR>

<A NAME="build(java.io.Reader)"><!-- --></A><H3>
build</H3>
<PRE>
public <A HREF="../../../../com/sun/syndication/feed/WireFeed.html" title="class in com.sun.syndication.feed">WireFeed</A> <B>build</B>(java.io.Reader&nbsp;reader)
               throws java.lang.IllegalArgumentException,
                      <A HREF="../../../../com/sun/syndication/io/FeedException.html" title="class in com.sun.syndication.io">FeedException</A></PRE>
<DL>
<DD>Builds an WireFeed (RSS or Atom) from an Reader.
 <p>
 NOTE: This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom.Document)'.
 <p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>reader</CODE> - Reader to read to create the WireFeed.
<DT><B>Returns:</B><DD>the WireFeed read from the Reader.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - thrown if feed type could not be understood by any of the underlying parsers.
<DD><CODE><A HREF="../../../../com/sun/syndication/io/FeedException.html" title="class in com.sun.syndication.io">FeedException</A></CODE> - if the feed could not be parsed</DL>
</DD>
</DL>
<HR>

<A NAME="build(org.xml.sax.InputSource)"><!-- --></A><H3>
build</H3>
<PRE>
public <A HREF="../../../../com/sun/syndication/feed/WireFeed.html" title="class in com.sun.syndication.feed">WireFeed</A> <B>build</B>(org.xml.sax.InputSource&nbsp;is)
               throws java.lang.IllegalArgumentException,
                      <A HREF="../../../../com/sun/syndication/io/FeedException.html" title="class in com.sun.syndication.io">FeedException</A></PRE>
<DL>
<DD>Builds an WireFeed (RSS or Atom) from an W3C SAX InputSource.
 <p>
 NOTE: This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom.Document)'.
 <p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>is</CODE> - W3C SAX InputSource to read to create the WireFeed.
<DT><B>Returns:</B><DD>the WireFeed read from the W3C SAX InputSource.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - thrown if feed type could not be understood by any of the underlying parsers.
<DD><CODE><A HREF="../../../../com/sun/syndication/io/FeedException.html" title="class in com.sun.syndication.io">FeedException</A></CODE> - if the feed could not be parsed</DL>
</DD>
</DL>
<HR>

<A NAME="build(org.w3c.dom.Document)"><!-- --></A><H3>
build</H3>
<PRE>
public <A HREF="../../../../com/sun/syndication/feed/WireFeed.html" title="class in com.sun.syndication.feed">WireFeed</A> <B>build</B>(org.w3c.dom.Document&nbsp;document)
               throws java.lang.IllegalArgumentException,
                      <A HREF="../../../../com/sun/syndication/io/FeedException.html" title="class in com.sun.syndication.io">FeedException</A></PRE>
<DL>
<DD>Builds an WireFeed (RSS or Atom) from an W3C DOM document.
 <p>
 NOTE: This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom.Document)'.
 <p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>document</CODE> - W3C DOM document to read to create the WireFeed.
<DT><B>Returns:</B><DD>the WireFeed read from the W3C DOM document.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - thrown if feed type could not be understood by any of the underlying parsers.
<DD><CODE><A HREF="../../../../com/sun/syndication/io/FeedException.html" title="class in com.sun.syndication.io">FeedException</A></CODE> - if the feed could not be parsed</DL>
</DD>
</DL>
<HR>

<A NAME="build(org.jdom.Document)"><!-- --></A><H3>
build</H3>
<PRE>
public <A HREF="../../../../com/sun/syndication/feed/WireFeed.html" title="class in com.sun.syndication.feed">WireFeed</A> <B>build</B>(org.jdom.Document&nbsp;document)
               throws java.lang.IllegalArgumentException,
                      <A HREF="../../../../com/sun/syndication/io/FeedException.html" title="class in com.sun.syndication.io">FeedException</A></PRE>
<DL>
<DD>Builds an WireFeed (RSS or Atom) from an JDOM document.
 <p>
 NOTE: All other build methods delegate to this method.
 <p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>document</CODE> - JDOM document to read to create the WireFeed.
<DT><B>Returns:</B><DD>the WireFeed read from the JDOM document.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - thrown if feed type could not be understood by any of the underlying parsers.
<DD><CODE><A HREF="../../../../com/sun/syndication/io/FeedException.html" title="class in com.sun.syndication.io">FeedException</A></CODE> - if the feed could not be parsed</DL>
</DD>
</DL>
<HR>

<A NAME="createSAXBuilder()"><!-- --></A><H3>
createSAXBuilder</H3>
<PRE>
protected <A HREF="../../../../com/sun/syndication/io/SAXBuilder.html" title="class in com.sun.syndication.io">SAXBuilder</A> <B>createSAXBuilder</B>()</PRE>
<DL>
<DD>Creates and sets up a org.jdom.input.SAXBuilder for parsing.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a new org.jdom.input.SAXBuilder object</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/WireFeedInput.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/WireFeedGenerator.html" title="interface in com.sun.syndication.io"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../com/sun/syndication/io/WireFeedOutput.html" title="class 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/WireFeedInput.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="WireFeedInput.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>