source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/BuildLogger.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: 13.5 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:14 NZST 2007 -->
6<TITLE>
7BuildLogger (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.BuildLogger interface">
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="BuildLogger (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/BuildListener.html" title="interface in org.apache.tools.ant"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../org/apache/tools/ant/DynamicAttribute.html" title="interface in org.apache.tools.ant"><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="BuildLogger.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;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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</FONT>
85<BR>
86Interface BuildLogger</H2>
87<DL>
88<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/apache/tools/ant/BuildListener.html" title="interface in org.apache.tools.ant">BuildListener</A>, java.util.EventListener</DD>
89</DL>
90<DL>
91<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/tools/ant/listener/CommonsLoggingListener.html" title="class in org.apache.tools.ant.listener">CommonsLoggingListener</A>, <A HREF="../../../../org/apache/tools/ant/DefaultLogger.html" title="class in org.apache.tools.ant">DefaultLogger</A>, <A HREF="../../../../org/apache/tools/ant/taskdefs/RecorderEntry.html" title="class in org.apache.tools.ant.taskdefs">RecorderEntry</A>, <A HREF="../../../../org/apache/tools/ant/XmlLogger.html" title="class in org.apache.tools.ant">XmlLogger</A></DD>
92</DL>
93<HR>
94<DL>
95<DT>public interface <B>BuildLogger</B><DT>extends <A HREF="../../../../org/apache/tools/ant/BuildListener.html" title="interface in org.apache.tools.ant">BuildListener</A></DL>
96
97<P>
98Interface used by Ant to log the build output.
99
100 A build logger is a build listener which has the 'right' to send output to
101 the ant log, which is usually <code>System.out</code> unless redirected by
102 the <code>-logfile</code> option.
103<P>
104
105<P>
106<HR>
107
108<P>
109<!-- ======== NESTED CLASS SUMMARY ======== -->
110
111
112<!-- =========== FIELD SUMMARY =========== -->
113
114
115<!-- ======== CONSTRUCTOR SUMMARY ======== -->
116
117
118<!-- ========== METHOD SUMMARY =========== -->
119
120<A NAME="method_summary"><!-- --></A>
121<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
122<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
123<TD COLSPAN=2><FONT SIZE="+2">
124<B>Method Summary</B></FONT></TD>
125</TR>
126<TR BGCOLOR="white" CLASS="TableRowColor">
127<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
128<CODE>&nbsp;void</CODE></FONT></TD>
129<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/BuildLogger.html#setEmacsMode(boolean)">setEmacsMode</A></B>(boolean&nbsp;emacsMode)</CODE>
130
131<BR>
132&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets this logger to produce emacs (and other editor) friendly output.</TD>
133</TR>
134<TR BGCOLOR="white" CLASS="TableRowColor">
135<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
136<CODE>&nbsp;void</CODE></FONT></TD>
137<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/BuildLogger.html#setErrorPrintStream(java.io.PrintStream)">setErrorPrintStream</A></B>(java.io.PrintStream&nbsp;err)</CODE>
138
139<BR>
140&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the output stream to which this logger is to send error messages.</TD>
141</TR>
142<TR BGCOLOR="white" CLASS="TableRowColor">
143<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
144<CODE>&nbsp;void</CODE></FONT></TD>
145<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/BuildLogger.html#setMessageOutputLevel(int)">setMessageOutputLevel</A></B>(int&nbsp;level)</CODE>
146
147<BR>
148&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the highest level of message this logger should respond to.</TD>
149</TR>
150<TR BGCOLOR="white" CLASS="TableRowColor">
151<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
152<CODE>&nbsp;void</CODE></FONT></TD>
153<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/BuildLogger.html#setOutputPrintStream(java.io.PrintStream)">setOutputPrintStream</A></B>(java.io.PrintStream&nbsp;output)</CODE>
154
155<BR>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the output stream to which this logger is to send its output.</TD>
157</TR>
158</TABLE>
159&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.BuildListener"><!-- --></A>
160<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
161<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
162<TD><B>Methods inherited from interface org.apache.tools.ant.<A HREF="../../../../org/apache/tools/ant/BuildListener.html" title="interface in org.apache.tools.ant">BuildListener</A></B></TD>
163</TR>
164<TR BGCOLOR="white" CLASS="TableRowColor">
165<TD><CODE><A HREF="../../../../org/apache/tools/ant/BuildListener.html#buildFinished(org.apache.tools.ant.BuildEvent)">buildFinished</A>, <A HREF="../../../../org/apache/tools/ant/BuildListener.html#buildStarted(org.apache.tools.ant.BuildEvent)">buildStarted</A>, <A HREF="../../../../org/apache/tools/ant/BuildListener.html#messageLogged(org.apache.tools.ant.BuildEvent)">messageLogged</A>, <A HREF="../../../../org/apache/tools/ant/BuildListener.html#targetFinished(org.apache.tools.ant.BuildEvent)">targetFinished</A>, <A HREF="../../../../org/apache/tools/ant/BuildListener.html#targetStarted(org.apache.tools.ant.BuildEvent)">targetStarted</A>, <A HREF="../../../../org/apache/tools/ant/BuildListener.html#taskFinished(org.apache.tools.ant.BuildEvent)">taskFinished</A>, <A HREF="../../../../org/apache/tools/ant/BuildListener.html#taskStarted(org.apache.tools.ant.BuildEvent)">taskStarted</A></CODE></TD>
166</TR>
167</TABLE>
168&nbsp;
169<P>
170
171<!-- ============ FIELD DETAIL =========== -->
172
173
174<!-- ========= CONSTRUCTOR DETAIL ======== -->
175
176
177<!-- ============ METHOD DETAIL ========== -->
178
179<A NAME="method_detail"><!-- --></A>
180<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
181<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
182<TD COLSPAN=1><FONT SIZE="+2">
183<B>Method Detail</B></FONT></TD>
184</TR>
185</TABLE>
186
187<A NAME="setMessageOutputLevel(int)"><!-- --></A><H3>
188setMessageOutputLevel</H3>
189<PRE>
190public void <B>setMessageOutputLevel</B>(int&nbsp;level)</PRE>
191<DL>
192<DD>Sets the highest level of message this logger should respond to.
193
194 Only messages with a message level lower than or equal to the
195 given level should be written to the log.
196 <P>
197 Constants for the message levels are in the
198 <A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant"><CODE>Project</CODE></A> class. The order of the levels, from least
199 to most verbose, is <code>MSG_ERR</code>, <code>MSG_WARN</code>,
200 <code>MSG_INFO</code>, <code>MSG_VERBOSE</code>,
201 <code>MSG_DEBUG</code>.
202<P>
203<DD><DL>
204</DL>
205</DD>
206<DD><DL>
207<DT><B>Parameters:</B><DD><CODE>level</CODE> - the logging level for the logger.</DL>
208</DD>
209</DL>
210<HR>
211
212<A NAME="setOutputPrintStream(java.io.PrintStream)"><!-- --></A><H3>
213setOutputPrintStream</H3>
214<PRE>
215public void <B>setOutputPrintStream</B>(java.io.PrintStream&nbsp;output)</PRE>
216<DL>
217<DD>Sets the output stream to which this logger is to send its output.
218<P>
219<DD><DL>
220</DL>
221</DD>
222<DD><DL>
223<DT><B>Parameters:</B><DD><CODE>output</CODE> - The output stream for the logger.
224 Must not be <code>null</code>.</DL>
225</DD>
226</DL>
227<HR>
228
229<A NAME="setEmacsMode(boolean)"><!-- --></A><H3>
230setEmacsMode</H3>
231<PRE>
232public void <B>setEmacsMode</B>(boolean&nbsp;emacsMode)</PRE>
233<DL>
234<DD>Sets this logger to produce emacs (and other editor) friendly output.
235<P>
236<DD><DL>
237</DL>
238</DD>
239<DD><DL>
240<DT><B>Parameters:</B><DD><CODE>emacsMode</CODE> - <code>true</code> if output is to be unadorned so that
241 emacs and other editors can parse files names, etc.</DL>
242</DD>
243</DL>
244<HR>
245
246<A NAME="setErrorPrintStream(java.io.PrintStream)"><!-- --></A><H3>
247setErrorPrintStream</H3>
248<PRE>
249public void <B>setErrorPrintStream</B>(java.io.PrintStream&nbsp;err)</PRE>
250<DL>
251<DD>Sets the output stream to which this logger is to send error messages.
252<P>
253<DD><DL>
254</DL>
255</DD>
256<DD><DL>
257<DT><B>Parameters:</B><DD><CODE>err</CODE> - The error stream for the logger.
258 Must not be <code>null</code>.</DL>
259</DD>
260</DL>
261<!-- ========= END OF CLASS DATA ========= -->
262<HR>
263
264
265<!-- ======= START OF BOTTOM NAVBAR ====== -->
266<A NAME="navbar_bottom"><!-- --></A>
267<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
268<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
269<TR>
270<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
271<A NAME="navbar_bottom_firstrow"><!-- --></A>
272<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
273 <TR ALIGN="center" VALIGN="top">
274 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
275 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
276 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
277 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
278 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
279 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
280 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
281 </TR>
282</TABLE>
283</TD>
284<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
285</EM>
286</TD>
287</TR>
288
289<TR>
290<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
291&nbsp;<A HREF="../../../../org/apache/tools/ant/BuildListener.html" title="interface in org.apache.tools.ant"><B>PREV CLASS</B></A>&nbsp;
292&nbsp;<A HREF="../../../../org/apache/tools/ant/DynamicAttribute.html" title="interface in org.apache.tools.ant"><B>NEXT CLASS</B></A></FONT></TD>
293<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
294 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
295&nbsp;<A HREF="BuildLogger.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
296&nbsp;<SCRIPT type="text/javascript">
297 <!--
298 if(window==top) {
299 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
300 }
301 //-->
302</SCRIPT>
303<NOSCRIPT>
304 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
305</NOSCRIPT>
306
307</FONT></TD>
308</TR>
309<TR>
310<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
311 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
312<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
313DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
314</TR>
315</TABLE>
316<A NAME="skip-navbar_bottom"></A>
317<!-- ======== END OF BOTTOM NAVBAR ======= -->
318
319<HR>
320Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
321</BODY>
322</HTML>
Note: See TracBrowser for help on using the repository browser.