source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/perforce/P4OutputStream.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker

File size: 12.8 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:29 NZST 2007 -->
6<TITLE>
7P4OutputStream (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.perforce.P4OutputStream 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="P4OutputStream (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;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Labelsync.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Reopen.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><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="P4OutputStream.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;FIELD&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.taskdefs.optional.perforce</FONT>
85<BR>
86Class P4OutputStream</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by">java.io.OutputStream
90 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.perforce.P4OutputStream</B>
91</PRE>
92<HR>
93<DL>
94<DT>public class <B>P4OutputStream</B><DT>extends java.io.OutputStream</DL>
95
96<P>
97heavily inspired from LogOutputStream
98 this stream class calls back the P4Handler on each line of stdout or stderr read
99<P>
100
101<P>
102<HR>
103
104<P>
105<!-- ======== NESTED CLASS SUMMARY ======== -->
106
107
108<!-- =========== FIELD SUMMARY =========== -->
109
110
111<!-- ======== CONSTRUCTOR SUMMARY ======== -->
112
113<A NAME="constructor_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>Constructor Summary</B></FONT></TD>
118</TR>
119<TR BGCOLOR="white" CLASS="TableRowColor">
120<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4OutputStream.html#P4OutputStream(org.apache.tools.ant.taskdefs.optional.perforce.P4Handler)">P4OutputStream</A></B>(<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Handler.html" title="interface in org.apache.tools.ant.taskdefs.optional.perforce">P4Handler</A>&nbsp;handler)</CODE>
121
122<BR>
123&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;creates a new P4OutputStream for a P4Handler</TD>
124</TR>
125</TABLE>
126&nbsp;
127<!-- ========== METHOD SUMMARY =========== -->
128
129<A NAME="method_summary"><!-- --></A>
130<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
131<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
132<TD COLSPAN=2><FONT SIZE="+2">
133<B>Method Summary</B></FONT></TD>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137<CODE>&nbsp;void</CODE></FONT></TD>
138<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4OutputStream.html#close()">close</A></B>()</CODE>
139
140<BR>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Writes all remaining</TD>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145<CODE>protected &nbsp;void</CODE></FONT></TD>
146<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4OutputStream.html#processBuffer()">processBuffer</A></B>()</CODE>
147
148<BR>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts the buffer to a string and sends it to <code>processLine</code></TD>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153<CODE>&nbsp;void</CODE></FONT></TD>
154<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4OutputStream.html#write(int)">write</A></B>(int&nbsp;cc)</CODE>
155
156<BR>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Write the data to the buffer and flush the buffer, if a line
158 separator is detected.</TD>
159</TR>
160</TABLE>
161&nbsp;<A NAME="methods_inherited_from_class_java.io.OutputStream"><!-- --></A>
162<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
163<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
164<TD><B>Methods inherited from class java.io.OutputStream</B></TD>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<TD><CODE>flush, write, write</CODE></TD>
168</TR>
169</TABLE>
170&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
171<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
172<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
173<TD><B>Methods inherited from class java.lang.Object</B></TD>
174</TR>
175<TR BGCOLOR="white" CLASS="TableRowColor">
176<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
177</TR>
178</TABLE>
179&nbsp;
180<P>
181
182<!-- ============ FIELD DETAIL =========== -->
183
184
185<!-- ========= CONSTRUCTOR DETAIL ======== -->
186
187<A NAME="constructor_detail"><!-- --></A>
188<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
189<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
190<TD COLSPAN=1><FONT SIZE="+2">
191<B>Constructor Detail</B></FONT></TD>
192</TR>
193</TABLE>
194
195<A NAME="P4OutputStream(org.apache.tools.ant.taskdefs.optional.perforce.P4Handler)"><!-- --></A><H3>
196P4OutputStream</H3>
197<PRE>
198public <B>P4OutputStream</B>(<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Handler.html" title="interface in org.apache.tools.ant.taskdefs.optional.perforce">P4Handler</A>&nbsp;handler)</PRE>
199<DL>
200<DD>creates a new P4OutputStream for a P4Handler
201<P>
202<DT><B>Parameters:</B><DD><CODE>handler</CODE> - the handler which will process the streams</DL>
203
204<!-- ============ METHOD DETAIL ========== -->
205
206<A NAME="method_detail"><!-- --></A>
207<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
208<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
209<TD COLSPAN=1><FONT SIZE="+2">
210<B>Method Detail</B></FONT></TD>
211</TR>
212</TABLE>
213
214<A NAME="write(int)"><!-- --></A><H3>
215write</H3>
216<PRE>
217public void <B>write</B>(int&nbsp;cc)
218 throws java.io.IOException</PRE>
219<DL>
220<DD>Write the data to the buffer and flush the buffer, if a line
221 separator is detected.
222<P>
223<DD><DL>
224<DT><B>Parameters:</B><DD><CODE>cc</CODE> - data to log (byte).
225<DT><B>Throws:</B>
226<DD><CODE>java.io.IOException</CODE> - IOException if an I/O error occurs. In particular,
227 an <code>IOException</code> may be thrown if the
228 output stream has been closed.</DL>
229</DD>
230</DL>
231<HR>
232
233<A NAME="processBuffer()"><!-- --></A><H3>
234processBuffer</H3>
235<PRE>
236protected void <B>processBuffer</B>()</PRE>
237<DL>
238<DD>Converts the buffer to a string and sends it to <code>processLine</code>
239<P>
240<DD><DL>
241</DL>
242</DD>
243</DL>
244<HR>
245
246<A NAME="close()"><!-- --></A><H3>
247close</H3>
248<PRE>
249public void <B>close</B>()
250 throws java.io.IOException</PRE>
251<DL>
252<DD>Writes all remaining
253<P>
254<DD><DL>
255
256<DT><B>Throws:</B>
257<DD><CODE>java.io.IOException</CODE> - if an I/O error occurs.</DL>
258</DD>
259</DL>
260<!-- ========= END OF CLASS DATA ========= -->
261<HR>
262
263
264<!-- ======= START OF BOTTOM NAVBAR ====== -->
265<A NAME="navbar_bottom"><!-- --></A>
266<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
267<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
268<TR>
269<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
270<A NAME="navbar_bottom_firstrow"><!-- --></A>
271<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
272 <TR ALIGN="center" VALIGN="top">
273 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
274 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
275 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
276 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
277 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
278 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
279 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
280 </TR>
281</TABLE>
282</TD>
283<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
284</EM>
285</TD>
286</TR>
287
288<TR>
289<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
290&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Labelsync.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><B>PREV CLASS</B></A>&nbsp;
291&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Reopen.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><B>NEXT CLASS</B></A></FONT></TD>
292<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
293 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
294&nbsp;<A HREF="P4OutputStream.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
295&nbsp;<SCRIPT type="text/javascript">
296 <!--
297 if(window==top) {
298 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
299 }
300 //-->
301</SCRIPT>
302<NOSCRIPT>
303 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
304</NOSCRIPT>
305
306</FONT></TD>
307</TR>
308<TR>
309<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
310 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
311<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
312DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
313</TR>
314</TABLE>
315<A NAME="skip-navbar_bottom"></A>
316<!-- ======== END OF BOTTOM NAVBAR ======= -->
317
318<HR>
319Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
320</BODY>
321</HTML>
Note: See TracBrowser for help on using the repository browser.