PageRenderTime 40ms CodeModel.GetById 15ms RepoModel.GetById 0ms app.codeStats 0ms

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

#
HTML | 258 lines | 211 code | 35 blank | 12 comment | 0 complexity | 7acf7dab1fde029ba0c665328f9a47e7 MD5 | raw file
Possible License(s): BSD-3-Clause, AGPL-1.0, Apache-2.0, LGPL-2.0, LGPL-3.0, GPL-2.0, CC-BY-SA-3.0, LGPL-2.1, GPL-3.0, MPL-2.0-no-copyleft-exception, IPL-1.0 
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!--NewPage-->
    3. 

  3. <HTML>
    4. 

  4. <HEAD>
    5. 

  5. <!-- Generated by javadoc (build 1.5.0_14) on Tue Jul 22 07:14:02 GMT-08:00 2008 -->
    6. 

  6. <TITLE>
    7. 

  7. BufferLocalEncodingDetector (jEdit API)
    8. 

  8. </TITLE>
    9. 

  9. 

  10. <META NAME="keywords" CONTENT="org.gjt.sp.jedit.io.BufferLocalEncodingDetector class">
    11. 

  11. 

  12. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
    13. 

  13. 

  14. 

  15. <NOSCRIPT>
    16. 

  16. </NOSCRIPT>
    17. 

  17. 

  18. </HEAD>
    19. 

  19. 

  20. <BODY BGCOLOR="white" >
    21. 

  21. 

  22. 

  23. <!-- ========= START OF TOP NAVBAR ======= -->
    24. 

  24. <A NAME="navbar_top"><!-- --></A>
    25. 

  25. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
    26. 

  26. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    27. 

  27. <TR>
    28. 

  28. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    29. 

  29. <A NAME="navbar_top_firstrow"><!-- --></A>
    30. 

  30. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    31. 

  31.   <TR ALIGN="center" VALIGN="top">
    32. 

  32.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    33. 

  33.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    34. 

  34.   <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    35. 

  35.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BufferLocalEncodingDetector.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    36. 

  36.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    37. 

  37.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    38. 

  38.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    39. 

  39.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    40. 

  40.   </TR>
    41. 

  41. </TABLE>
    42. 

  42. </TD>
    43. 

  43. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    44. 

  44. </EM>
    45. 

  45. </TD>
    46. 

  46. </TR>
    47. 

  47. 

  48. <TR>
    49. 

  49. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    50. 

  50. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/io/AutoDetection.Result.html" title="class in org.gjt.sp.jedit.io"><B>PREV CLASS</B></A>&nbsp;
    51. 

  51. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/io/CharsetEncoding.html" title="class in org.gjt.sp.jedit.io"><B>NEXT CLASS</B></A></FONT></TD>
    52. 

  52. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    53. 

  53.   <A HREF="../../../../../index.html?org/gjt/sp/jedit/io/BufferLocalEncodingDetector.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    54. 

  54. &nbsp;<A HREF="BufferLocalEncodingDetector.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    55. 

  55. &nbsp;
    56. 

  56. <NOSCRIPT>
    57. 

  57.   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
    58. 

  58. </NOSCRIPT>
    59. 

  59. 

  60. 

  61. </FONT></TD>
    62. 

  62. </TR>
    63. 

  63. <TR>
    64. 

  64. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    65. 

  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. 

  66. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    67. 

  67. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    68. 

  68. </TR>
    69. 

  69. </TABLE>
    70. 

  70. <A NAME="skip-navbar_top"></A>
    71. 

  71. <!-- ========= END OF TOP NAVBAR ========= -->
    72. 

  72. 

  73. <HR>
    74. 

  74. <!-- ======== START OF CLASS DATA ======== -->
    75. 

  75. <H2>
    76. 

  76. <FONT SIZE="-1">
    77. 

  77. org.gjt.sp.jedit.io</FONT>
    78. 

  78. <BR>
    79. 

  79. Class BufferLocalEncodingDetector</H2>
    80. 

  80. <PRE>
    81. 

  81. java.lang.Object
    82. 

  82.   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.io.BufferLocalEncodingDetector</B>
    83. 

  83. </PRE>
    84. 

  84. <DL>
    85. 

  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. 

  86. </DL>
    87. 

  87. <HR>
    88. 

  88. <DL>
    89. 

  89. <DT><PRE>public class <B>BufferLocalEncodingDetector</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>
    90. 

  90. </PRE>
    91. 

  91. 

  92. <P>
    93. 

  93. An encoding detector which finds buffer-local-property syntax.
    94. 

  94. 

  95.  This reads the sample in the system default encoding for first 10
    96. 

  96.  lines and look for ":encoding=..." syntax. This can fail if the
    97. 

  97.  stream cannot be read in the system default encoding or
    98. 

  98.  ":encoding=..." is not placed at near the top of the stream.
    99. 

  99. <P>
    100. 

  100. 

  101. <P>
    102. 

  102. <DL>
    103. 

  103. <DT><B>Since:</B></DT>
    104. 

  104.   <DD>4.3pre10</DD>
    105. 

  105. </DL>
    106. 

  106. <HR>
    107. 

  107. 

  108. <P>
    109. 

  109. 

  110. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
    111. 

  111. 

  112. <A NAME="constructor_summary"><!-- --></A>
    113. 

  113. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    114. 

  114. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    115. 

  115. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    116. 

  116. <B>Constructor Summary</B></FONT></TH>
    117. 

  117. </TR>
    118. 

  118. <TR BGCOLOR="white" CLASS="TableRowColor">
    119. 

  119. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/BufferLocalEncodingDetector.html#BufferLocalEncodingDetector()">BufferLocalEncodingDetector</A></B>()</CODE>
    120. 

  120. 

  121. <BR>
    122. 

  122. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    123. 

  123. </TR>
    124. 

  124. </TABLE>
    125. 

  125. &nbsp;
    126. 

  126. <!-- ========== METHOD SUMMARY =========== -->
    127. 

  127. 

  128. <A NAME="method_summary"><!-- --></A>
    129. 

  129. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    130. 

  130. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    131. 

  131. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    132. 

  132. <B>Method Summary</B></FONT></TH>
    133. 

  133. </TR>
    134. 

  134. <TR BGCOLOR="white" CLASS="TableRowColor">
    135. 

  135. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    136. 

  136. <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
    137. 

  137. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/BufferLocalEncodingDetector.html#detectEncoding(java.io.InputStream)">detectEncoding</A></B>(java.io.InputStream&nbsp;sample)</CODE>
    138. 

  138. 

  139. <BR>
    140. 

  140. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of a detected encoding for the bytes in sample.</TD>
    141. 

  141. </TR>
    142. 

  142. </TABLE>
    143. 

  143. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
    144. 

  144. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    145. 

  145. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
    146. 

  146. <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
    147. 

  147. </TR>
    148. 

  148. <TR BGCOLOR="white" CLASS="TableRowColor">
    149. 

  149. <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
    150. 

  150. </TR>
    151. 

  151. </TABLE>
    152. 

  152. &nbsp;
    153. 

  153. <P>
    154. 

  154. 

  155. <!-- ========= CONSTRUCTOR DETAIL ======== -->
    156. 

  156. 

  157. <A NAME="constructor_detail"><!-- --></A>
    158. 

  158. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    159. 

  159. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    160. 

  160. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    161. 

  161. <B>Constructor Detail</B></FONT></TH>
    162. 

  162. </TR>
    163. 

  163. </TABLE>
    164. 

  164. 

  165. <A NAME="BufferLocalEncodingDetector()"><!-- --></A><H3>
    166. 

  166. BufferLocalEncodingDetector</H3>
    167. 

  167. <PRE>
    168. 

  168. public <B>BufferLocalEncodingDetector</B>()</PRE>
    169. 

  169. <DL>
    170. 

  170. </DL>
    171. 

  171. 

  172. <!-- ============ METHOD DETAIL ========== -->
    173. 

  173. 

  174. <A NAME="method_detail"><!-- --></A>
    175. 

  175. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    176. 

  176. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    177. 

  177. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    178. 

  178. <B>Method Detail</B></FONT></TH>
    179. 

  179. </TR>
    180. 

  180. </TABLE>
    181. 

  181. 

  182. <A NAME="detectEncoding(java.io.InputStream)"><!-- --></A><H3>
    183. 

  183. detectEncoding</H3>
    184. 

  184. <PRE>
    185. 

  185. public java.lang.String <B>detectEncoding</B>(java.io.InputStream&nbsp;sample)
    186. 

  186.                                 throws java.io.IOException</PRE>
    187. 

  187. <DL>
    188. 

  188. <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>
    189. 

  189. <DD>Returns the name of a detected encoding for the bytes in sample.
    190. 

  190.  Returns null if this instance could not detect reasonable one.
    191. 

  191. <P>
    192. 

  192. <DD><DL>
    193. 

  193. <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>
    194. 

  194. </DD>
    195. 

  195. <DD><DL>
    196. 

  196. 

  197. <DT><B>Throws:</B>
    198. 

  198. <DD><CODE>java.io.IOException</CODE></DL>
    199. 

  199. </DD>
    200. 

  200. </DL>
    201. 

  201. <!-- ========= END OF CLASS DATA ========= -->
    202. 

  202. <HR>
    203. 

  203. 

  204. 

  205. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    206. 

  206. <A NAME="navbar_bottom"><!-- --></A>
    207. 

  207. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    208. 

  208. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    209. 

  209. <TR>
    210. 

  210. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    211. 

  211. <A NAME="navbar_bottom_firstrow"><!-- --></A>
    212. 

  212. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    213. 

  213.   <TR ALIGN="center" VALIGN="top">
    214. 

  214.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    215. 

  215.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    216. 

  216.   <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    217. 

  217.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BufferLocalEncodingDetector.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    218. 

  218.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    219. 

  219.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    220. 

  220.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    221. 

  221.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    222. 

  222.   </TR>
    223. 

  223. </TABLE>
    224. 

  224. </TD>
    225. 

  225. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    226. 

  226. </EM>
    227. 

  227. </TD>
    228. 

  228. </TR>
    229. 

  229. 

  230. <TR>
    231. 

  231. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    232. 

  232. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/io/AutoDetection.Result.html" title="class in org.gjt.sp.jedit.io"><B>PREV CLASS</B></A>&nbsp;
    233. 

  233. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/io/CharsetEncoding.html" title="class in org.gjt.sp.jedit.io"><B>NEXT CLASS</B></A></FONT></TD>
    234. 

  234. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    235. 

  235.   <A HREF="../../../../../index.html?org/gjt/sp/jedit/io/BufferLocalEncodingDetector.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    236. 

  236. &nbsp;<A HREF="BufferLocalEncodingDetector.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    237. 

  237. &nbsp;
    238. 

  238. <NOSCRIPT>
    239. 

  239.   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
    240. 

  240. </NOSCRIPT>
    241. 

  241. 

  242. 

  243. </FONT></TD>
    244. 

  244. </TR>
    245. 

  245. <TR>
    246. 

  246. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    247. 

  247.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    248. 

  248. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    249. 

  249. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    250. 

  250. </TR>
    251. 

  251. </TABLE>
    252. 

  252. <A NAME="skip-navbar_bottom"></A>
    253. 

  253. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    254. 

  254. 

  255. <HR>
    256. 

  256. 

  257. </BODY>
    258. 

  258. </HTML>
    259. 

  259.