xmlreader.html

来自「rsslibj-1_0RC2,RSS阅读」· HTML 代码 · 共 694 行 · 第 1/2 页

XmlReader</H3>
<PRE>
public <B>XmlReader</B>(java.io.InputStream&nbsp;is,
                 boolean&nbsp;lenient)
          throws java.io.IOException,
                 <A HREF="../../../../com/sun/syndication/io/XmlReaderException.html" title="class in com.sun.syndication.io">XmlReaderException</A></PRE>
<DL>
<DD>Creates a Reader for a raw InputStream.
 <p>
 It follows the same logic used for files.
 <p>
 If lenient detection is indicated and the detection above fails as per specifications it then attempts
 the following:
 <p>
 If the content type was 'text/html' it replaces it with 'text/xml' and tries the detection again.
 <p>
 Else if the XML prolog had a charset encoding that encoding is used.
 <p>
 Else if the content type had a charset encoding that encoding is used.
 <p>
 Else 'UTF-8' is used.
 <p>
 If lenient detection is indicated an XmlReaderException is never thrown.
 <p>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>is</CODE> - InputStream to create a Reader from.<DD><CODE>lenient</CODE> - indicates if the charset encoding detection should be relaxed.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - thrown if there is a problem reading the stream.
<DD><CODE><A HREF="../../../../com/sun/syndication/io/XmlReaderException.html" title="class in com.sun.syndication.io">XmlReaderException</A></CODE> - thrown if the charset encoding could not be determined according to the specs.</DL>
</DL>
<HR>

<A NAME="XmlReader(java.net.URL)"><!-- --></A><H3>
XmlReader</H3>
<PRE>
public <B>XmlReader</B>(java.net.URL&nbsp;url)
          throws java.io.IOException</PRE>
<DL>
<DD>Creates a Reader using the InputStream of a URL.
 <p>
 If the URL is not of type HTTP and there is not 'content-type' header in the fetched
 data it uses the same logic used for Files.
 <p>
 If the URL is a HTTP Url or there is a 'content-type' header in the fetched
 data it uses the same logic used for an InputStream with content-type.
 <p>
 It does a lenient charset encoding detection, check the constructor with the lenient parameter
 for details.
 <p>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>url</CODE> - URL to create a Reader from.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - thrown if there is a problem reading the stream of the URL.</DL>
</DL>
<HR>

<A NAME="XmlReader(java.net.URLConnection)"><!-- --></A><H3>
XmlReader</H3>
<PRE>
public <B>XmlReader</B>(java.net.URLConnection&nbsp;conn)
          throws java.io.IOException</PRE>
<DL>
<DD>Creates a Reader using the InputStream of a URLConnection.
 <p>
 If the URLConnection is not of type HttpURLConnection and there is not
 'content-type' header in the fetched data it uses the same logic used for files.
 <p>
 If the URLConnection is a HTTP Url or there is a 'content-type' header in the fetched
 data it uses the same logic used for an InputStream with content-type.
 <p>
 It does a lenient charset encoding detection, check the constructor with the lenient parameter
 for details.
 <p>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>conn</CODE> - URLConnection to create a Reader from.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - thrown if there is a problem reading the stream of the URLConnection.</DL>
</DL>
<HR>

<A NAME="XmlReader(java.io.InputStream, java.lang.String)"><!-- --></A><H3>
XmlReader</H3>
<PRE>
public <B>XmlReader</B>(java.io.InputStream&nbsp;is,
                 java.lang.String&nbsp;httpContentType)
          throws java.io.IOException</PRE>
<DL>
<DD>Creates a Reader using an InputStream an the associated content-type header.
 <p>
 First it checks if the stream has BOM. If there is not BOM checks the content-type encoding.
 If there is not content-type encoding checks the XML prolog encoding. If there is not XML
 prolog encoding uses the default encoding mandated by the content-type MIME type.
 <p>
 It does a lenient charset encoding detection, check the constructor with the lenient parameter
 for details.
 <p>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>is</CODE> - InputStream to create the reader from.<DD><CODE>httpContentType</CODE> - content-type header to use for the resolution of the charset encoding.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - thrown if there is a problem reading the file.</DL>
</DL>
<HR>

<A NAME="XmlReader(java.io.InputStream, java.lang.String, boolean, java.lang.String)"><!-- --></A><H3>
XmlReader</H3>
<PRE>
public <B>XmlReader</B>(java.io.InputStream&nbsp;is,
                 java.lang.String&nbsp;httpContentType,
                 boolean&nbsp;lenient,
                 java.lang.String&nbsp;defaultEncoding)
          throws java.io.IOException,
                 <A HREF="../../../../com/sun/syndication/io/XmlReaderException.html" title="class in com.sun.syndication.io">XmlReaderException</A></PRE>
<DL>
<DD>Creates a Reader using an InputStream an the associated content-type header. This constructor is
 lenient regarding the encoding detection.
 <p>
 First it checks if the stream has BOM. If there is not BOM checks the content-type encoding.
 If there is not content-type encoding checks the XML prolog encoding. If there is not XML
 prolog encoding uses the default encoding mandated by the content-type MIME type.
 <p>
 If lenient detection is indicated and the detection above fails as per specifications it then attempts
 the following:
 <p>
 If the content type was 'text/html' it replaces it with 'text/xml' and tries the detection again.
 <p>
 Else if the XML prolog had a charset encoding that encoding is used.
 <p>
 Else if the content type had a charset encoding that encoding is used.
 <p>
 Else 'UTF-8' is used.
 <p>
 If lenient detection is indicated an XmlReaderException is never thrown.
 <p>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>is</CODE> - InputStream to create the reader from.<DD><CODE>httpContentType</CODE> - content-type header to use for the resolution of the charset encoding.<DD><CODE>lenient</CODE> - indicates if the charset encoding detection should be relaxed.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - thrown if there is a problem reading the file.
<DD><CODE><A HREF="../../../../com/sun/syndication/io/XmlReaderException.html" title="class in com.sun.syndication.io">XmlReaderException</A></CODE> - thrown if the charset encoding could not be determined according to the specs.</DL>
</DL>
<HR>

<A NAME="XmlReader(java.io.InputStream, java.lang.String, boolean)"><!-- --></A><H3>
XmlReader</H3>
<PRE>
public <B>XmlReader</B>(java.io.InputStream&nbsp;is,
                 java.lang.String&nbsp;httpContentType,
                 boolean&nbsp;lenient)
          throws java.io.IOException,
                 <A HREF="../../../../com/sun/syndication/io/XmlReaderException.html" title="class in com.sun.syndication.io">XmlReaderException</A></PRE>
<DL>
<DD>Creates a Reader using an InputStream an the associated content-type header. This constructor is
 lenient regarding the encoding detection.
 <p>
 First it checks if the stream has BOM. If there is not BOM checks the content-type encoding.
 If there is not content-type encoding checks the XML prolog encoding. If there is not XML
 prolog encoding uses the default encoding mandated by the content-type MIME type.
 <p>
 If lenient detection is indicated and the detection above fails as per specifications it then attempts
 the following:
 <p>
 If the content type was 'text/html' it replaces it with 'text/xml' and tries the detection again.
 <p>
 Else if the XML prolog had a charset encoding that encoding is used.
 <p>
 Else if the content type had a charset encoding that encoding is used.
 <p>
 Else 'UTF-8' is used.
 <p>
 If lenient detection is indicated an XmlReaderException is never thrown.
 <p>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>is</CODE> - InputStream to create the reader from.<DD><CODE>httpContentType</CODE> - content-type header to use for the resolution of the charset encoding.<DD><CODE>lenient</CODE> - indicates if the charset encoding detection should be relaxed.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - thrown if there is a problem reading the file.
<DD><CODE><A HREF="../../../../com/sun/syndication/io/XmlReaderException.html" title="class in com.sun.syndication.io">XmlReaderException</A></CODE> - thrown if the charset encoding could not be determined according to the specs.</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="setDefaultEncoding(java.lang.String)"><!-- --></A><H3>
setDefaultEncoding</H3>
<PRE>
public static void <B>setDefaultEncoding</B>(java.lang.String&nbsp;encoding)</PRE>
<DL>
<DD>Sets the default encoding to use if none is set in HTTP content-type,
 XML prolog and the rules based on content-type are not adequate.
 <p/>
 If it is set to NULL the content-type based rules are used.
 <p/>
 By default it is NULL.
 <p/>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>encoding</CODE> - charset encoding to default to.</DL>
</DD>
</DL>
<HR>

<A NAME="getDefaultEncoding()"><!-- --></A><H3>
getDefaultEncoding</H3>
<PRE>
public static java.lang.String <B>getDefaultEncoding</B>()</PRE>
<DL>
<DD>Returns the default encoding to use if none is set in HTTP content-type,
 XML prolog and the rules based on content-type are not adequate.
 <p/>
 If it is NULL the content-type based rules are used.
 <p/>
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the default encoding to use.</DL>
</DD>
</DL>
<HR>

<A NAME="getEncoding()"><!-- --></A><H3>
getEncoding</H3>
<PRE>
public java.lang.String <B>getEncoding</B>()</PRE>
<DL>
<DD>Returns the charset encoding of the XmlReader.
 <p>
<P>
<DD><DL>

<DT><B>Returns:</B><DD>charset encoding.</DL>
</DD>
</DL>
<HR>

<A NAME="read(char[], int, int)"><!-- --></A><H3>
read</H3>
<PRE>
public int <B>read</B>(char[]&nbsp;buf,
                int&nbsp;offset,
                int&nbsp;len)
         throws java.io.IOException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>read</CODE> in class <CODE>java.io.Reader</CODE></DL>
</DD>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>

<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
public void <B>close</B>()
           throws java.io.IOException</PRE>
<DL>
<DD>Closes the XmlReader stream.
 <p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>close</CODE> in interface <CODE>java.io.Closeable</CODE><DT><B>Specified by:</B><DD><CODE>close</CODE> in class <CODE>java.io.Reader</CODE></DL>
</DD>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - thrown if there was a problem closing the stream.</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/XmlReader.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/WireFeedParser.html" title="interface in com.sun.syndication.io"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../com/sun/syndication/io/XmlReaderException.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/XmlReader.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="XmlReader.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;<A HREF="#fields_inherited_from_class_java.io.Reader">FIELD</A>&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>