source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/filters/BaseFilterReader.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 19.9 KB
Line 
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.4.2_13) on Mon Oct 01 14:33:16 NZST 2007 -->
6<TITLE>
7BaseFilterReader (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.filters.BaseFilterReader class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="BaseFilterReader (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;PREV CLASS&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/filters/BaseParamFilterReader.html" title="class in org.apache.tools.ant.filters"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="BaseFilterReader.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_java.io.FilterReader">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.filters</FONT>
85<BR>
86Class BaseFilterReader</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by">java.io.Reader
90 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by">java.io.FilterReader
91 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.filters.BaseFilterReader</B>
92</PRE>
93<DL>
94<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/tools/ant/filters/BaseParamFilterReader.html" title="class in org.apache.tools.ant.filters">BaseParamFilterReader</A>, <A HREF="../../../../../org/apache/tools/ant/filters/ClassConstants.html" title="class in org.apache.tools.ant.filters">ClassConstants</A>, <A HREF="../../../../../org/apache/tools/ant/filters/ExpandProperties.html" title="class in org.apache.tools.ant.filters">ExpandProperties</A>, <A HREF="../../../../../org/apache/tools/ant/filters/StripJavaComments.html" title="class in org.apache.tools.ant.filters">StripJavaComments</A>, <A HREF="../../../../../org/apache/tools/ant/filters/TokenFilter.html" title="class in org.apache.tools.ant.filters">TokenFilter</A></DD>
95</DL>
96<HR>
97<DL>
98<DT>public abstract class <B>BaseFilterReader</B><DT>extends java.io.FilterReader</DL>
99
100<P>
101Base class for core filter readers.
102<P>
103
104<P>
105<HR>
106
107<P>
108<!-- ======== NESTED CLASS SUMMARY ======== -->
109
110
111<!-- =========== FIELD SUMMARY =========== -->
112
113<A NAME="field_summary"><!-- --></A>
114<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
115<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
116<TD COLSPAN=2><FONT SIZE="+2">
117<B>Field Summary</B></FONT></TD>
118</TR>
119</TABLE>
120&nbsp;<A NAME="fields_inherited_from_class_java.io.FilterReader"><!-- --></A>
121<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
122<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
123<TD><B>Fields inherited from class java.io.FilterReader</B></TD>
124</TR>
125<TR BGCOLOR="white" CLASS="TableRowColor">
126<TD><CODE>in</CODE></TD>
127</TR>
128</TABLE>
129&nbsp;<A NAME="fields_inherited_from_class_java.io.Reader"><!-- --></A>
130<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
131<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
132<TD><B>Fields inherited from class java.io.Reader</B></TD>
133</TR>
134<TR BGCOLOR="white" CLASS="TableRowColor">
135<TD><CODE>lock</CODE></TD>
136</TR>
137</TABLE>
138&nbsp;
139<!-- ======== CONSTRUCTOR SUMMARY ======== -->
140
141<A NAME="constructor_summary"><!-- --></A>
142<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
143<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
144<TD COLSPAN=2><FONT SIZE="+2">
145<B>Constructor Summary</B></FONT></TD>
146</TR>
147<TR BGCOLOR="white" CLASS="TableRowColor">
148<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html#BaseFilterReader()">BaseFilterReader</A></B>()</CODE>
149
150<BR>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor used by Ant's introspection mechanism.</TD>
152</TR>
153<TR BGCOLOR="white" CLASS="TableRowColor">
154<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html#BaseFilterReader(java.io.Reader)">BaseFilterReader</A></B>(java.io.Reader&nbsp;in)</CODE>
155
156<BR>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new filtered reader.</TD>
158</TR>
159</TABLE>
160&nbsp;
161<!-- ========== METHOD SUMMARY =========== -->
162
163<A NAME="method_summary"><!-- --></A>
164<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
165<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
166<TD COLSPAN=2><FONT SIZE="+2">
167<B>Method Summary</B></FONT></TD>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171<CODE>protected &nbsp;boolean</CODE></FONT></TD>
172<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html#getInitialized()">getInitialized</A></B>()</CODE>
173
174<BR>
175&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the initialized status.</TD>
176</TR>
177<TR BGCOLOR="white" CLASS="TableRowColor">
178<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179<CODE>protected &nbsp;<A HREF="../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A></CODE></FONT></TD>
180<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html#getProject()">getProject</A></B>()</CODE>
181
182<BR>
183&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the project this filter is part of.</TD>
184</TR>
185<TR BGCOLOR="white" CLASS="TableRowColor">
186<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187<CODE>&nbsp;int</CODE></FONT></TD>
188<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html#read(char[], int, int)">read</A></B>(char[]&nbsp;cbuf,
189 int&nbsp;off,
190 int&nbsp;len)</CODE>
191
192<BR>
193&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads characters into a portion of an array.</TD>
194</TR>
195<TR BGCOLOR="white" CLASS="TableRowColor">
196<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
197<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
198<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html#readFully()">readFully</A></B>()</CODE>
199
200<BR>
201&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads to the end of the stream, returning the contents as a String.</TD>
202</TR>
203<TR BGCOLOR="white" CLASS="TableRowColor">
204<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
205<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
206<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html#readLine()">readLine</A></B>()</CODE>
207
208<BR>
209&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads a line of text ending with '\n' (or until the end of the stream).</TD>
210</TR>
211<TR BGCOLOR="white" CLASS="TableRowColor">
212<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
213<CODE>protected &nbsp;void</CODE></FONT></TD>
214<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html#setInitialized(boolean)">setInitialized</A></B>(boolean&nbsp;initialized)</CODE>
215
216<BR>
217&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the initialized status.</TD>
218</TR>
219<TR BGCOLOR="white" CLASS="TableRowColor">
220<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
221<CODE>&nbsp;void</CODE></FONT></TD>
222<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html#setProject(org.apache.tools.ant.Project)">setProject</A></B>(<A HREF="../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project)</CODE>
223
224<BR>
225&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the project to work with.</TD>
226</TR>
227<TR BGCOLOR="white" CLASS="TableRowColor">
228<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
229<CODE>&nbsp;long</CODE></FONT></TD>
230<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html#skip(long)">skip</A></B>(long&nbsp;n)</CODE>
231
232<BR>
233&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Skips characters.</TD>
234</TR>
235</TABLE>
236&nbsp;<A NAME="methods_inherited_from_class_java.io.FilterReader"><!-- --></A>
237<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
238<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
239<TD><B>Methods inherited from class java.io.FilterReader</B></TD>
240</TR>
241<TR BGCOLOR="white" CLASS="TableRowColor">
242<TD><CODE>close, mark, markSupported, read, ready, reset</CODE></TD>
243</TR>
244</TABLE>
245&nbsp;<A NAME="methods_inherited_from_class_java.io.Reader"><!-- --></A>
246<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
247<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
248<TD><B>Methods inherited from class java.io.Reader</B></TD>
249</TR>
250<TR BGCOLOR="white" CLASS="TableRowColor">
251<TD><CODE>read</CODE></TD>
252</TR>
253</TABLE>
254&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
255<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
256<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
257<TD><B>Methods inherited from class java.lang.Object</B></TD>
258</TR>
259<TR BGCOLOR="white" CLASS="TableRowColor">
260<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
261</TR>
262</TABLE>
263&nbsp;
264<P>
265
266<!-- ============ FIELD DETAIL =========== -->
267
268
269<!-- ========= CONSTRUCTOR DETAIL ======== -->
270
271<A NAME="constructor_detail"><!-- --></A>
272<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
273<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
274<TD COLSPAN=1><FONT SIZE="+2">
275<B>Constructor Detail</B></FONT></TD>
276</TR>
277</TABLE>
278
279<A NAME="BaseFilterReader()"><!-- --></A><H3>
280BaseFilterReader</H3>
281<PRE>
282public <B>BaseFilterReader</B>()</PRE>
283<DL>
284<DD>Constructor used by Ant's introspection mechanism.
285 The original filter reader is only used for chaining
286 purposes, never for filtering purposes (and indeed
287 it would be useless for filtering purposes, as it has
288 no real data to filter). ChainedReaderHelper uses
289 this placeholder instance to create a chain of real filters.
290<P>
291</DL>
292<HR>
293
294<A NAME="BaseFilterReader(java.io.Reader)"><!-- --></A><H3>
295BaseFilterReader</H3>
296<PRE>
297public <B>BaseFilterReader</B>(java.io.Reader&nbsp;in)</PRE>
298<DL>
299<DD>Creates a new filtered reader.
300<P>
301<DT><B>Parameters:</B><DD><CODE>in</CODE> - A Reader object providing the underlying stream.
302 Must not be <code>null</code>.</DL>
303
304<!-- ============ METHOD DETAIL ========== -->
305
306<A NAME="method_detail"><!-- --></A>
307<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
308<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
309<TD COLSPAN=1><FONT SIZE="+2">
310<B>Method Detail</B></FONT></TD>
311</TR>
312</TABLE>
313
314<A NAME="read(char[], int, int)"><!-- --></A><H3>
315read</H3>
316<PRE>
317public final int <B>read</B>(char[]&nbsp;cbuf,
318 int&nbsp;off,
319 int&nbsp;len)
320 throws java.io.IOException</PRE>
321<DL>
322<DD>Reads characters into a portion of an array. This method will block
323 until some input is available, an I/O error occurs, or the end of the
324 stream is reached.
325<P>
326<DD><DL>
327<DT><B>Parameters:</B><DD><CODE>cbuf</CODE> - Destination buffer to write characters to.
328 Must not be <code>null</code>.<DD><CODE>off</CODE> - Offset at which to start storing characters.<DD><CODE>len</CODE> - Maximum number of characters to read.
329<DT><B>Returns:</B><DD>the number of characters read, or -1 if the end of the
330 stream has been reached
331<DT><B>Throws:</B>
332<DD><CODE>java.io.IOException</CODE> - If an I/O error occurs</DL>
333</DD>
334</DL>
335<HR>
336
337<A NAME="skip(long)"><!-- --></A><H3>
338skip</H3>
339<PRE>
340public final long <B>skip</B>(long&nbsp;n)
341 throws java.io.IOException,
342 java.lang.IllegalArgumentException</PRE>
343<DL>
344<DD>Skips characters. This method will block until some characters are
345 available, an I/O error occurs, or the end of the stream is reached.
346<P>
347<DD><DL>
348<DT><B>Parameters:</B><DD><CODE>n</CODE> - The number of characters to skip
349<DT><B>Returns:</B><DD>the number of characters actually skipped
350<DT><B>Throws:</B>
351<DD><CODE>java.lang.IllegalArgumentException</CODE> - If <code>n</code> is negative.
352<DD><CODE>java.io.IOException</CODE> - If an I/O error occurs</DL>
353</DD>
354</DL>
355<HR>
356
357<A NAME="setInitialized(boolean)"><!-- --></A><H3>
358setInitialized</H3>
359<PRE>
360protected final void <B>setInitialized</B>(boolean&nbsp;initialized)</PRE>
361<DL>
362<DD>Sets the initialized status.
363<P>
364<DD><DL>
365<DT><B>Parameters:</B><DD><CODE>initialized</CODE> - Whether or not the filter is initialized.</DL>
366</DD>
367</DL>
368<HR>
369
370<A NAME="getInitialized()"><!-- --></A><H3>
371getInitialized</H3>
372<PRE>
373protected final boolean <B>getInitialized</B>()</PRE>
374<DL>
375<DD>Returns the initialized status.
376<P>
377<DD><DL>
378
379<DT><B>Returns:</B><DD>whether or not the filter is initialized</DL>
380</DD>
381</DL>
382<HR>
383
384<A NAME="setProject(org.apache.tools.ant.Project)"><!-- --></A><H3>
385setProject</H3>
386<PRE>
387public final void <B>setProject</B>(<A HREF="../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project)</PRE>
388<DL>
389<DD>Sets the project to work with.
390<P>
391<DD><DL>
392<DT><B>Parameters:</B><DD><CODE>project</CODE> - The project this filter is part of.
393 Should not be <code>null</code>.</DL>
394</DD>
395</DL>
396<HR>
397
398<A NAME="getProject()"><!-- --></A><H3>
399getProject</H3>
400<PRE>
401protected final <A HREF="../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> <B>getProject</B>()</PRE>
402<DL>
403<DD>Returns the project this filter is part of.
404<P>
405<DD><DL>
406
407<DT><B>Returns:</B><DD>the project this filter is part of</DL>
408</DD>
409</DL>
410<HR>
411
412<A NAME="readLine()"><!-- --></A><H3>
413readLine</H3>
414<PRE>
415protected final java.lang.String <B>readLine</B>()
416 throws java.io.IOException</PRE>
417<DL>
418<DD>Reads a line of text ending with '\n' (or until the end of the stream).
419 The returned String retains the '\n'.
420<P>
421<DD><DL>
422
423<DT><B>Returns:</B><DD>the line read, or <code>null</code> if the end of the stream
424 has already been reached
425<DT><B>Throws:</B>
426<DD><CODE>java.io.IOException</CODE> - if the underlying reader throws one during
427 reading</DL>
428</DD>
429</DL>
430<HR>
431
432<A NAME="readFully()"><!-- --></A><H3>
433readFully</H3>
434<PRE>
435protected final java.lang.String <B>readFully</B>()
436 throws java.io.IOException</PRE>
437<DL>
438<DD>Reads to the end of the stream, returning the contents as a String.
439<P>
440<DD><DL>
441
442<DT><B>Returns:</B><DD>the remaining contents of the reader, as a String
443<DT><B>Throws:</B>
444<DD><CODE>java.io.IOException</CODE> - if the underlying reader throws one during
445 reading</DL>
446</DD>
447</DL>
448<!-- ========= END OF CLASS DATA ========= -->
449<HR>
450
451
452<!-- ======= START OF BOTTOM NAVBAR ====== -->
453<A NAME="navbar_bottom"><!-- --></A>
454<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
455<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
456<TR>
457<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
458<A NAME="navbar_bottom_firstrow"><!-- --></A>
459<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
460 <TR ALIGN="center" VALIGN="top">
461 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
462 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
463 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
464 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
465 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
466 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
467 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
468 </TR>
469</TABLE>
470</TD>
471<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
472</EM>
473</TD>
474</TR>
475
476<TR>
477<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
478&nbsp;PREV CLASS&nbsp;
479&nbsp;<A HREF="../../../../../org/apache/tools/ant/filters/BaseParamFilterReader.html" title="class in org.apache.tools.ant.filters"><B>NEXT CLASS</B></A></FONT></TD>
480<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
481 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
482&nbsp;<A HREF="BaseFilterReader.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
483&nbsp;<SCRIPT type="text/javascript">
484 <!--
485 if(window==top) {
486 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
487 }
488 //-->
489</SCRIPT>
490<NOSCRIPT>
491 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
492</NOSCRIPT>
493
494</FONT></TD>
495</TR>
496<TR>
497<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
498 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_java.io.FilterReader">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
499<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
500DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
501</TR>
502</TABLE>
503<A NAME="skip-navbar_bottom"></A>
504<!-- ======== END OF BOTTOM NAVBAR ======= -->
505
506<HR>
507Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
508</BODY>
509</HTML>
Note: See TracBrowser for help on using the repository browser.