PageRenderTime 352ms CodeModel.GetById 336ms app.highlight 13ms RepoModel.GetById 1ms app.codeStats 0ms

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

#
HTML | 262 lines | 217 code | 35 blank | 10 comment | 0 complexity | 0151ef3db79ef92cfbc3cf29022adbdf 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>
  7Encoding (jEdit API)
  8</TITLE>
  9
 10<META NAME="keywords" CONTENT="org.gjt.sp.jedit.io.Encoding interface">
 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/Encoding.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/CopyFileWorker.html" title="class in org.gjt.sp.jedit.io"><B>PREV CLASS</B></A>&nbsp;
 51&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/io/EncodingDetector.html" title="interface 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/Encoding.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 54&nbsp;<A HREF="Encoding.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;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 66<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 67DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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>
 79Interface Encoding</H2>
 80<DL>
 81<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/gjt/sp/jedit/io/CharsetEncoding.html" title="class in org.gjt.sp.jedit.io">CharsetEncoding</A>, <A HREF="../../../../../org/gjt/sp/jedit/io/EncodingWithBOM.html" title="class in org.gjt.sp.jedit.io">EncodingWithBOM</A></DD>
 82</DL>
 83<HR>
 84<DL>
 85<DT><PRE>public interface <B>Encoding</B></DL>
 86</PRE>
 87
 88<P>
 89An interface to represent an encoding.
 90 An encoding is a mapping between a character stream and a byte
 91 stream. It is like java.nio.charset.Charset but has slightly
 92 different form. This can represents some extended encodings like
 93 UTF-8Y which drops (inserts) the BOM bytes before actual decoding
 94 (encoding). This also enables to add some extended encodings such
 95 as ASCII representation used by Java property files.
 96<P>
 97
 98<P>
 99<DL>
100<DT><B>Since:</B></DT>
101  <DD>4.3pre10</DD>
102</DL>
103<HR>
104
105<P>
106
107<!-- ========== METHOD SUMMARY =========== -->
108
109<A NAME="method_summary"><!-- --></A>
110<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
111<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
112<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
113<B>Method Summary</B></FONT></TH>
114</TR>
115<TR BGCOLOR="white" CLASS="TableRowColor">
116<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
117<CODE>&nbsp;java.io.Reader</CODE></FONT></TD>
118<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/Encoding.html#getPermissiveTextReader(java.io.InputStream)">getPermissiveTextReader</A></B>(java.io.InputStream&nbsp;in)</CODE>
119
120<BR>
121&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Map an InputStream to a Reader.</TD>
122</TR>
123<TR BGCOLOR="white" CLASS="TableRowColor">
124<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
125<CODE>&nbsp;java.io.Reader</CODE></FONT></TD>
126<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/Encoding.html#getTextReader(java.io.InputStream)">getTextReader</A></B>(java.io.InputStream&nbsp;in)</CODE>
127
128<BR>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Map an InputStream to a Reader.</TD>
130</TR>
131<TR BGCOLOR="white" CLASS="TableRowColor">
132<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
133<CODE>&nbsp;java.io.Writer</CODE></FONT></TD>
134<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/Encoding.html#getTextWriter(java.io.OutputStream)">getTextWriter</A></B>(java.io.OutputStream&nbsp;out)</CODE>
135
136<BR>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Map an OutputStream to a Writer.</TD>
138</TR>
139</TABLE>
140&nbsp;
141<P>
142
143<!-- ============ METHOD DETAIL ========== -->
144
145<A NAME="method_detail"><!-- --></A>
146<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
147<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
148<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
149<B>Method Detail</B></FONT></TH>
150</TR>
151</TABLE>
152
153<A NAME="getTextReader(java.io.InputStream)"><!-- --></A><H3>
154getTextReader</H3>
155<PRE>
156java.io.Reader <B>getTextReader</B>(java.io.InputStream&nbsp;in)
157                             throws java.io.IOException</PRE>
158<DL>
159<DD>Map an InputStream to a Reader.
160 Decode-error while reading from this Reader should be reported
161 by throwing an IOException.
162<P>
163<DD><DL>
164
165<DT><B>Throws:</B>
166<DD><CODE>java.io.IOException</CODE></DL>
167</DD>
168</DL>
169<HR>
170
171<A NAME="getTextWriter(java.io.OutputStream)"><!-- --></A><H3>
172getTextWriter</H3>
173<PRE>
174java.io.Writer <B>getTextWriter</B>(java.io.OutputStream&nbsp;out)
175                             throws java.io.IOException</PRE>
176<DL>
177<DD>Map an OutputStream to a Writer.
178 Encode-error while writing to this Writer should be reported
179 by throwing an IOException.
180<P>
181<DD><DL>
182
183<DT><B>Throws:</B>
184<DD><CODE>java.io.IOException</CODE></DL>
185</DD>
186</DL>
187<HR>
188
189<A NAME="getPermissiveTextReader(java.io.InputStream)"><!-- --></A><H3>
190getPermissiveTextReader</H3>
191<PRE>
192java.io.Reader <B>getPermissiveTextReader</B>(java.io.InputStream&nbsp;in)
193                                       throws java.io.IOException</PRE>
194<DL>
195<DD>Map an InputStream to a Reader.
196 Decode-error while reading from this Reader should be ignored
197 or replaced.
198<P>
199<DD><DL>
200
201<DT><B>Throws:</B>
202<DD><CODE>java.io.IOException</CODE></DL>
203</DD>
204</DL>
205<!-- ========= END OF CLASS DATA ========= -->
206<HR>
207
208
209<!-- ======= START OF BOTTOM NAVBAR ====== -->
210<A NAME="navbar_bottom"><!-- --></A>
211<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
212<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
213<TR>
214<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
215<A NAME="navbar_bottom_firstrow"><!-- --></A>
216<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
217  <TR ALIGN="center" VALIGN="top">
218  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
219  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
220  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
221  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Encoding.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
222  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
223  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
224  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
225  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
226  </TR>
227</TABLE>
228</TD>
229<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
230</EM>
231</TD>
232</TR>
233
234<TR>
235<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
236&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/io/CopyFileWorker.html" title="class in org.gjt.sp.jedit.io"><B>PREV CLASS</B></A>&nbsp;
237&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/io/EncodingDetector.html" title="interface in org.gjt.sp.jedit.io"><B>NEXT CLASS</B></A></FONT></TD>
238<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
239  <A HREF="../../../../../index.html?org/gjt/sp/jedit/io/Encoding.html" target="_top"><B>FRAMES</B></A>  &nbsp;
240&nbsp;<A HREF="Encoding.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
241&nbsp;
242<NOSCRIPT>
243  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
244</NOSCRIPT>
245
246
247</FONT></TD>
248</TR>
249<TR>
250<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
251  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
252<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
253DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
254</TR>
255</TABLE>
256<A NAME="skip-navbar_bottom"></A>
257<!-- ======== END OF BOTTOM NAVBAR ======= -->
258
259<HR>
260
261</BODY>
262</HTML>