PageRenderTime 92ms CodeModel.GetById 78ms app.highlight 10ms RepoModel.GetById 1ms app.codeStats 0ms

/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/jedit/io/EncodingWithBOM.Detector.html

#
HTML | 248 lines | 203 code | 33 blank | 12 comment | 0 complexity | 8fb026293f51e31ac9f4fa69fe37ace0 MD5 | raw file
  1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2<!--NewPage-->
  3<HTML>
  4<HEAD>
  5<!-- Generated by javadoc (build 1.5.0_14) on Tue Jul 22 07:14:02 GMT-08:00 2008 -->
  6<TITLE>
  7EncodingWithBOM.Detector (jEdit API)
  8</TITLE>
  9
 10<META NAME="keywords" CONTENT="org.gjt.sp.jedit.io.EncodingWithBOM.Detector class">
 11
 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
 13
 14
 15<NOSCRIPT>
 16</NOSCRIPT>
 17
 18</HEAD>
 19
 20<BODY BGCOLOR="white" >
 21
 22
 23<!-- ========= START OF TOP NAVBAR ======= -->
 24<A NAME="navbar_top"><!-- --></A>
 25<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
 26<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 27<TR>
 28<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 29<A NAME="navbar_top_firstrow"><!-- --></A>
 30<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 31  <TR ALIGN="center" VALIGN="top">
 32  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 33  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 34  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 35  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/EncodingWithBOM.Detector.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 36  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 37  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 38  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 39  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 40  </TR>
 41</TABLE>
 42</TD>
 43<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 44</EM>
 45</TD>
 46</TR>
 47
 48<TR>
 49<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 50&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/io/EncodingWithBOM.html" title="class in org.gjt.sp.jedit.io"><B>PREV CLASS</B></A>&nbsp;
 51&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/io/FavoritesVFS.html" title="class in org.gjt.sp.jedit.io"><B>NEXT CLASS</B></A></FONT></TD>
 52<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 53  <A HREF="../../../../../index.html?org/gjt/sp/jedit/io/EncodingWithBOM.Detector.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 54&nbsp;<A HREF="EncodingWithBOM.Detector.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 55&nbsp;
 56<NOSCRIPT>
 57  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 58</NOSCRIPT>
 59
 60
 61</FONT></TD>
 62</TR>
 63<TR>
 64<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 65  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 66<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 67DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 68</TR>
 69</TABLE>
 70<A NAME="skip-navbar_top"></A>
 71<!-- ========= END OF TOP NAVBAR ========= -->
 72
 73<HR>
 74<!-- ======== START OF CLASS DATA ======== -->
 75<H2>
 76<FONT SIZE="-1">
 77org.gjt.sp.jedit.io</FONT>
 78<BR>
 79Class EncodingWithBOM.Detector</H2>
 80<PRE>
 81java.lang.Object
 82  <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.io.EncodingWithBOM.Detector</B>
 83</PRE>
 84<DL>
 85<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/gjt/sp/jedit/io/EncodingDetector.html" title="interface in org.gjt.sp.jedit.io">EncodingDetector</A></DD>
 86</DL>
 87<DL>
 88<DT><B>Enclosing class:</B><DD><A HREF="../../../../../org/gjt/sp/jedit/io/EncodingWithBOM.html" title="class in org.gjt.sp.jedit.io">EncodingWithBOM</A></DD>
 89</DL>
 90<HR>
 91<DL>
 92<DT><PRE>public static class <B>EncodingWithBOM.Detector</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/gjt/sp/jedit/io/EncodingDetector.html" title="interface in org.gjt.sp.jedit.io">EncodingDetector</A></DL>
 93</PRE>
 94
 95<P>
 96<HR>
 97
 98<P>
 99
100<!-- ======== CONSTRUCTOR SUMMARY ======== -->
101
102<A NAME="constructor_summary"><!-- --></A>
103<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
104<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
105<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
106<B>Constructor Summary</B></FONT></TH>
107</TR>
108<TR BGCOLOR="white" CLASS="TableRowColor">
109<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/EncodingWithBOM.Detector.html#EncodingWithBOM.Detector()">EncodingWithBOM.Detector</A></B>()</CODE>
110
111<BR>
112&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
113</TR>
114</TABLE>
115&nbsp;
116<!-- ========== METHOD SUMMARY =========== -->
117
118<A NAME="method_summary"><!-- --></A>
119<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
120<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
121<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
122<B>Method Summary</B></FONT></TH>
123</TR>
124<TR BGCOLOR="white" CLASS="TableRowColor">
125<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
126<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
127<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/EncodingWithBOM.Detector.html#detectEncoding(java.io.InputStream)">detectEncoding</A></B>(java.io.InputStream&nbsp;sample)</CODE>
128
129<BR>
130&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of a detected encoding for the bytes in sample.</TD>
131</TR>
132</TABLE>
133&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
134<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
135<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
136<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
137</TR>
138<TR BGCOLOR="white" CLASS="TableRowColor">
139<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
140</TR>
141</TABLE>
142&nbsp;
143<P>
144
145<!-- ========= CONSTRUCTOR DETAIL ======== -->
146
147<A NAME="constructor_detail"><!-- --></A>
148<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
149<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
150<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
151<B>Constructor Detail</B></FONT></TH>
152</TR>
153</TABLE>
154
155<A NAME="EncodingWithBOM.Detector()"><!-- --></A><H3>
156EncodingWithBOM.Detector</H3>
157<PRE>
158public <B>EncodingWithBOM.Detector</B>()</PRE>
159<DL>
160</DL>
161
162<!-- ============ METHOD DETAIL ========== -->
163
164<A NAME="method_detail"><!-- --></A>
165<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
166<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
167<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
168<B>Method Detail</B></FONT></TH>
169</TR>
170</TABLE>
171
172<A NAME="detectEncoding(java.io.InputStream)"><!-- --></A><H3>
173detectEncoding</H3>
174<PRE>
175public java.lang.String <B>detectEncoding</B>(java.io.InputStream&nbsp;sample)
176                                throws java.io.IOException</PRE>
177<DL>
178<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/gjt/sp/jedit/io/EncodingDetector.html#detectEncoding(java.io.InputStream)">EncodingDetector</A></CODE></B></DD>
179<DD>Returns the name of a detected encoding for the bytes in sample.
180 Returns null if this instance could not detect reasonable one.
181<P>
182<DD><DL>
183<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/gjt/sp/jedit/io/EncodingDetector.html#detectEncoding(java.io.InputStream)">detectEncoding</A></CODE> in interface <CODE><A HREF="../../../../../org/gjt/sp/jedit/io/EncodingDetector.html" title="interface in org.gjt.sp.jedit.io">EncodingDetector</A></CODE></DL>
184</DD>
185<DD><DL>
186
187<DT><B>Throws:</B>
188<DD><CODE>java.io.IOException</CODE></DL>
189</DD>
190</DL>
191<!-- ========= END OF CLASS DATA ========= -->
192<HR>
193
194
195<!-- ======= START OF BOTTOM NAVBAR ====== -->
196<A NAME="navbar_bottom"><!-- --></A>
197<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
198<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
199<TR>
200<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
201<A NAME="navbar_bottom_firstrow"><!-- --></A>
202<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
203  <TR ALIGN="center" VALIGN="top">
204  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
205  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
206  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
207  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/EncodingWithBOM.Detector.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
208  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
209  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
210  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
211  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
212  </TR>
213</TABLE>
214</TD>
215<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
216</EM>
217</TD>
218</TR>
219
220<TR>
221<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
222&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/io/EncodingWithBOM.html" title="class in org.gjt.sp.jedit.io"><B>PREV CLASS</B></A>&nbsp;
223&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/io/FavoritesVFS.html" title="class in org.gjt.sp.jedit.io"><B>NEXT CLASS</B></A></FONT></TD>
224<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
225  <A HREF="../../../../../index.html?org/gjt/sp/jedit/io/EncodingWithBOM.Detector.html" target="_top"><B>FRAMES</B></A>  &nbsp;
226&nbsp;<A HREF="EncodingWithBOM.Detector.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
227&nbsp;
228<NOSCRIPT>
229  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
230</NOSCRIPT>
231
232
233</FONT></TD>
234</TR>
235<TR>
236<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
237  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
238<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
239DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
240</TR>
241</TABLE>
242<A NAME="skip-navbar_bottom"></A>
243<!-- ======== END OF BOTTOM NAVBAR ======= -->
244
245<HR>
246
247</BODY>
248</HTML>