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

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

initial import of LiRK3
File size: 16.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:17 NZST 2007 -->
6<TITLE>
7AnsiColorLogger (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.listener.AnsiColorLogger 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="AnsiColorLogger (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/listener/CommonsLoggingListener.html" title="class in org.apache.tools.ant.listener"><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="AnsiColorLogger.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_org.apache.tools.ant.DefaultLogger">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.listener</FONT>
85<BR>
86Class AnsiColorLogger</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html" title="class in org.apache.tools.ant">org.apache.tools.ant.DefaultLogger</A>
90 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.listener.AnsiColorLogger</B>
91</PRE>
92<DL>
93<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/tools/ant/BuildListener.html" title="interface in org.apache.tools.ant">BuildListener</A>, <A HREF="../../../../../org/apache/tools/ant/BuildLogger.html" title="interface in org.apache.tools.ant">BuildLogger</A>, java.util.EventListener</DD>
94</DL>
95<HR>
96<DL>
97<DT>public final class <B>AnsiColorLogger</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html" title="class in org.apache.tools.ant">DefaultLogger</A></DL>
98
99<P>
100Uses ANSI Color Code Sequences to colorize messages
101 sent to the console.
102
103 If used with the -logfile option, the output file
104 will contain all the necessary escape codes to
105 display the text in colorized mode when displayed
106 in the console using applications like cat, more,
107 etc.
108
109 This is designed to work on terminals that support ANSI
110 color codes. It works on XTerm, ETerm, Mindterm, etc.
111 It also works on Win9x (with ANSI.SYS loaded.)
112
113 NOTE:
114 It doesn't work on WinNT's COMMAND.COM even with
115 ANSI.SYS loaded.
116
117 The default colors used for differentiating
118 the message levels can be changed by editing the
119 /org/apache/tools/ant/listener/defaults.properties
120 file.
121 This file contains 5 key/value pairs:
122 AnsiColorLogger.ERROR_COLOR=2;31
123 AnsiColorLogger.WARNING_COLOR=2;35
124 AnsiColorLogger.INFO_COLOR=2;36
125 AnsiColorLogger.VERBOSE_COLOR=2;32
126 AnsiColorLogger.DEBUG_COLOR=2;34
127
128 Another option is to pass a system variable named
129 ant.logger.defaults, with value set to the path of
130 the file that contains user defined Ansi Color
131 Codes, to the <B>java</B> command using -D option.
132
133 To change these colors use the following chart:
134
135 <B>ANSI COLOR LOGGER CONFIGURATION</B>
136
137 Format for AnsiColorLogger.*=
138 Attribute;Foreground;Background
139
140 Attribute is one of the following:
141 0 -> Reset All Attributes (return to normal mode)
142 1 -> Bright (Usually turns on BOLD)
143 2 -> Dim
144 3 -> Underline
145 5 -> link
146 7 -> Reverse
147 8 -> Hidden
148
149 Foreground is one of the following:
150 30 -> Black
151 31 -> Red
152 32 -> Green
153 33 -> Yellow
154 34 -> Blue
155 35 -> Magenta
156 36 -> Cyan
157 37 -> White
158
159 Background is one of the following:
160 40 -> Black
161 41 -> Red
162 42 -> Green
163 43 -> Yellow
164 44 -> Blue
165 45 -> Magenta
166 46 -> Cyan
167 47 -> White
168<P>
169
170<P>
171<HR>
172
173<P>
174<!-- ======== NESTED CLASS SUMMARY ======== -->
175
176
177<!-- =========== FIELD SUMMARY =========== -->
178
179<A NAME="field_summary"><!-- --></A>
180<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
181<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
182<TD COLSPAN=2><FONT SIZE="+2">
183<B>Field Summary</B></FONT></TD>
184</TR>
185</TABLE>
186&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.DefaultLogger"><!-- --></A>
187<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
188<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
189<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html" title="class in org.apache.tools.ant">DefaultLogger</A></B></TD>
190</TR>
191<TR BGCOLOR="white" CLASS="TableRowColor">
192<TD><CODE><A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#emacsMode">emacsMode</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#err">err</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#LEFT_COLUMN_SIZE">LEFT_COLUMN_SIZE</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#lSep">lSep</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#msgOutputLevel">msgOutputLevel</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#out">out</A></CODE></TD>
193</TR>
194</TABLE>
195&nbsp;
196<!-- ======== CONSTRUCTOR SUMMARY ======== -->
197
198<A NAME="constructor_summary"><!-- --></A>
199<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
200<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
201<TD COLSPAN=2><FONT SIZE="+2">
202<B>Constructor Summary</B></FONT></TD>
203</TR>
204<TR BGCOLOR="white" CLASS="TableRowColor">
205<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/listener/AnsiColorLogger.html#AnsiColorLogger()">AnsiColorLogger</A></B>()</CODE>
206
207<BR>
208&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
209</TR>
210</TABLE>
211&nbsp;
212<!-- ========== METHOD SUMMARY =========== -->
213
214<A NAME="method_summary"><!-- --></A>
215<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
216<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
217<TD COLSPAN=2><FONT SIZE="+2">
218<B>Method Summary</B></FONT></TD>
219</TR>
220<TR BGCOLOR="white" CLASS="TableRowColor">
221<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
222<CODE>protected &nbsp;void</CODE></FONT></TD>
223<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/listener/AnsiColorLogger.html#printMessage(java.lang.String, java.io.PrintStream, int)">printMessage</A></B>(java.lang.String&nbsp;message,
224 java.io.PrintStream&nbsp;stream,
225 int&nbsp;priority)</CODE>
226
227<BR>
228&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Prints a message to a PrintStream.</TD>
229</TR>
230</TABLE>
231&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.DefaultLogger"><!-- --></A>
232<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
233<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
234<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html" title="class in org.apache.tools.ant">DefaultLogger</A></B></TD>
235</TR>
236<TR BGCOLOR="white" CLASS="TableRowColor">
237<TD><CODE><A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#buildFinished(org.apache.tools.ant.BuildEvent)">buildFinished</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#buildStarted(org.apache.tools.ant.BuildEvent)">buildStarted</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#formatTime(long)">formatTime</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#log(java.lang.String)">log</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#messageLogged(org.apache.tools.ant.BuildEvent)">messageLogged</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#setEmacsMode(boolean)">setEmacsMode</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#setErrorPrintStream(java.io.PrintStream)">setErrorPrintStream</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#setMessageOutputLevel(int)">setMessageOutputLevel</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#setOutputPrintStream(java.io.PrintStream)">setOutputPrintStream</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#targetFinished(org.apache.tools.ant.BuildEvent)">targetFinished</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#targetStarted(org.apache.tools.ant.BuildEvent)">targetStarted</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#taskFinished(org.apache.tools.ant.BuildEvent)">taskFinished</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#taskStarted(org.apache.tools.ant.BuildEvent)">taskStarted</A></CODE></TD>
238</TR>
239</TABLE>
240&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
241<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
242<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
243<TD><B>Methods inherited from class java.lang.Object</B></TD>
244</TR>
245<TR BGCOLOR="white" CLASS="TableRowColor">
246<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
247</TR>
248</TABLE>
249&nbsp;
250<P>
251
252<!-- ============ FIELD DETAIL =========== -->
253
254
255<!-- ========= CONSTRUCTOR DETAIL ======== -->
256
257<A NAME="constructor_detail"><!-- --></A>
258<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
259<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
260<TD COLSPAN=1><FONT SIZE="+2">
261<B>Constructor Detail</B></FONT></TD>
262</TR>
263</TABLE>
264
265<A NAME="AnsiColorLogger()"><!-- --></A><H3>
266AnsiColorLogger</H3>
267<PRE>
268public <B>AnsiColorLogger</B>()</PRE>
269<DL>
270</DL>
271
272<!-- ============ METHOD DETAIL ========== -->
273
274<A NAME="method_detail"><!-- --></A>
275<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
276<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
277<TD COLSPAN=1><FONT SIZE="+2">
278<B>Method Detail</B></FONT></TD>
279</TR>
280</TABLE>
281
282<A NAME="printMessage(java.lang.String, java.io.PrintStream, int)"><!-- --></A><H3>
283printMessage</H3>
284<PRE>
285protected final void <B>printMessage</B>(java.lang.String&nbsp;message,
286 java.io.PrintStream&nbsp;stream,
287 int&nbsp;priority)</PRE>
288<DL>
289<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html" title="class in org.apache.tools.ant">DefaultLogger</A></CODE></B></DD>
290<DD>Prints a message to a PrintStream.
291<P>
292<DD><DL>
293<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#printMessage(java.lang.String, java.io.PrintStream, int)">printMessage</A></CODE> in class <CODE><A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html" title="class in org.apache.tools.ant">DefaultLogger</A></CODE></DL>
294</DD>
295<DD><DL>
296<DT><B>Parameters:</B><DD><CODE>message</CODE> - The message to print.
297 Should not be <code>null</code>.<DD><CODE>stream</CODE> - A PrintStream to print the message to.
298 Must not be <code>null</code>.<DD><CODE>priority</CODE> - The priority of the message.
299 (Ignored in this implementation.)<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#printMessage(java.lang.String, java.io.PrintStream, int)"><CODE>DefaultLogger.printMessage(java.lang.String, java.io.PrintStream, int)</CODE></A></DL>
300</DD>
301</DL>
302<!-- ========= END OF CLASS DATA ========= -->
303<HR>
304
305
306<!-- ======= START OF BOTTOM NAVBAR ====== -->
307<A NAME="navbar_bottom"><!-- --></A>
308<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
309<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
310<TR>
311<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
312<A NAME="navbar_bottom_firstrow"><!-- --></A>
313<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
314 <TR ALIGN="center" VALIGN="top">
315 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
316 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
317 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
318 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
319 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
320 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
321 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
322 </TR>
323</TABLE>
324</TD>
325<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
326</EM>
327</TD>
328</TR>
329
330<TR>
331<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
332&nbsp;PREV CLASS&nbsp;
333&nbsp;<A HREF="../../../../../org/apache/tools/ant/listener/CommonsLoggingListener.html" title="class in org.apache.tools.ant.listener"><B>NEXT CLASS</B></A></FONT></TD>
334<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
335 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
336&nbsp;<A HREF="AnsiColorLogger.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
337&nbsp;<SCRIPT type="text/javascript">
338 <!--
339 if(window==top) {
340 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
341 }
342 //-->
343</SCRIPT>
344<NOSCRIPT>
345 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
346</NOSCRIPT>
347
348</FONT></TD>
349</TR>
350<TR>
351<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
352 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.DefaultLogger">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
353<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
354DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
355</TR>
356</TABLE>
357<A NAME="skip-navbar_bottom"></A>
358<!-- ======== END OF BOTTOM NAVBAR ======= -->
359
360<HR>
361Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
362</BODY>
363</HTML>
Note: See TracBrowser for help on using the repository browser.