source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/metamata/MMetrics.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: 33.6 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:28 NZST 2007 -->
6<TITLE>
7MMetrics (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.metamata.MMetrics 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="MMetrics (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/metamata/MAudit.html" title="class in org.apache.tools.ant.taskdefs.optional.metamata"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/MMetrics.GranularityAttribute.html" title="class in org.apache.tools.ant.taskdefs.optional.metamata"><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="MMetrics.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;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.taskdefs.optional.metamata.AbstractMetamataTask">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.taskdefs.optional.metamata</FONT>
85<BR>
86Class MMetrics</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A>
90 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</A>
91 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html" title="class in org.apache.tools.ant.taskdefs.optional.metamata">org.apache.tools.ant.taskdefs.optional.metamata.AbstractMetamataTask</A>
92 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.metamata.MMetrics</B>
93</PRE>
94<HR>
95<DL>
96<DT>public class <B>MMetrics</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html" title="class in org.apache.tools.ant.taskdefs.optional.metamata">AbstractMetamataTask</A></DL>
97
98<P>
99Computes the metrics of a set of Java files and write the results to an XML
100 file. As a convenience, a stylesheet is given in <tt>etc</tt> directory,
101 so that an HTML report can be generated from the XML file.
102 <p>
103 You will not be able to use this task with the evaluation version since
104 as of Metamata 2.0, Metrics does not support command line :-(
105<P>
106
107<P>
108<HR>
109
110<P>
111<!-- ======== NESTED CLASS SUMMARY ======== -->
112
113<A NAME="nested_class_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>Nested Class Summary</B></FONT></TD>
118</TR>
119<TR BGCOLOR="white" CLASS="TableRowColor">
120<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
121<CODE>static&nbsp;class</CODE></FONT></TD>
122<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/MMetrics.GranularityAttribute.html" title="class in org.apache.tools.ant.taskdefs.optional.metamata">MMetrics.GranularityAttribute</A></B></CODE>
123
124<BR>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Attributes for granularity.</TD>
126</TR>
127</TABLE>
128&nbsp;
129<!-- =========== FIELD SUMMARY =========== -->
130
131<A NAME="field_summary"><!-- --></A>
132<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
133<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
134<TD COLSPAN=2><FONT SIZE="+2">
135<B>Field Summary</B></FONT></TD>
136</TR>
137</TABLE>
138&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.taskdefs.optional.metamata.AbstractMetamataTask"><!-- --></A>
139<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
140<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
141<TD><B>Fields inherited from class org.apache.tools.ant.taskdefs.optional.metamata.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html" title="class in org.apache.tools.ant.taskdefs.optional.metamata">AbstractMetamataTask</A></B></TD>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#classPath">classPath</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#cmdl">cmdl</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#fileSets">fileSets</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#includedFiles">includedFiles</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#metamataHome">metamataHome</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#optionsFile">optionsFile</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#sourcePath">sourcePath</A></CODE></TD>
145</TR>
146</TABLE>
147&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
148<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
149<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
150<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
151</TR>
152<TR BGCOLOR="white" CLASS="TableRowColor">
153<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#description">description</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#location">location</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#target">target</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#taskName">taskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#taskType">taskType</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#wrapper">wrapper</A></CODE></TD>
154</TR>
155</TABLE>
156&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
157<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
158<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
159<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
160</TR>
161<TR BGCOLOR="white" CLASS="TableRowColor">
162<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
163</TR>
164</TABLE>
165&nbsp;
166<!-- ======== CONSTRUCTOR SUMMARY ======== -->
167
168<A NAME="constructor_summary"><!-- --></A>
169<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
170<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
171<TD COLSPAN=2><FONT SIZE="+2">
172<B>Constructor Summary</B></FONT></TD>
173</TR>
174<TR BGCOLOR="white" CLASS="TableRowColor">
175<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/MMetrics.html#MMetrics()">MMetrics</A></B>()</CODE>
176
177<BR>
178&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;default constructor</TD>
179</TR>
180</TABLE>
181&nbsp;
182<!-- ========== METHOD SUMMARY =========== -->
183
184<A NAME="method_summary"><!-- --></A>
185<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
186<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
187<TD COLSPAN=2><FONT SIZE="+2">
188<B>Method Summary</B></FONT></TD>
189</TR>
190<TR BGCOLOR="white" CLASS="TableRowColor">
191<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
192<CODE>protected &nbsp;void</CODE></FONT></TD>
193<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/MMetrics.html#checkOptions()">checkOptions</A></B>()</CODE>
194
195<BR>
196&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;validate options set</TD>
197</TR>
198<TR BGCOLOR="white" CLASS="TableRowColor">
199<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
200<CODE>protected &nbsp;void</CODE></FONT></TD>
201<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/MMetrics.html#cleanUp()">cleanUp</A></B>()</CODE>
202
203<BR>
204&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cleanup the temporary txt report</TD>
205</TR>
206<TR BGCOLOR="white" CLASS="TableRowColor">
207<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
208<CODE>&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A></CODE></FONT></TD>
209<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/MMetrics.html#createPath()">createPath</A></B>()</CODE>
210
211<BR>
212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a new path (directory) to measure metrics from.</TD>
213</TR>
214<TR BGCOLOR="white" CLASS="TableRowColor">
215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216<CODE>protected &nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/ExecuteStreamHandler.html" title="interface in org.apache.tools.ant.taskdefs">ExecuteStreamHandler</A></CODE></FONT></TD>
217<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/MMetrics.html#createStreamHandler()">createStreamHandler</A></B>()</CODE>
218
219<BR>
220&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if the report is transform via a temporary txt file we should use a
221 a normal logger here, otherwise we could use the metrics handler
222 directly to capture and transform the output on stdout to XML.</TD>
223</TR>
224<TR BGCOLOR="white" CLASS="TableRowColor">
225<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
226<CODE>protected &nbsp;void</CODE></FONT></TD>
227<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/MMetrics.html#execute0(org.apache.tools.ant.taskdefs.ExecuteStreamHandler)">execute0</A></B>(<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/ExecuteStreamHandler.html" title="interface in org.apache.tools.ant.taskdefs">ExecuteStreamHandler</A>&nbsp;handler)</CODE>
228
229<BR>
230&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;execute the process with a specific handler</TD>
231</TR>
232<TR BGCOLOR="white" CLASS="TableRowColor">
233<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
234<CODE>protected &nbsp;java.util.Vector</CODE></FONT></TD>
235<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/MMetrics.html#getOptions()">getOptions</A></B>()</CODE>
236
237<BR>
238&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return all options of the command line as string elements</TD>
239</TR>
240<TR BGCOLOR="white" CLASS="TableRowColor">
241<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
242<CODE>&nbsp;void</CODE></FONT></TD>
243<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/MMetrics.html#setGranularity(org.apache.tools.ant.taskdefs.optional.metamata.MMetrics.GranularityAttribute)">setGranularity</A></B>(<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/MMetrics.GranularityAttribute.html" title="class in org.apache.tools.ant.taskdefs.optional.metamata">MMetrics.GranularityAttribute</A>&nbsp;granularity)</CODE>
244
245<BR>
246&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;set the granularity of the audit.</TD>
247</TR>
248<TR BGCOLOR="white" CLASS="TableRowColor">
249<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
250<CODE>&nbsp;void</CODE></FONT></TD>
251<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/MMetrics.html#setTofile(java.io.File)">setTofile</A></B>(java.io.File&nbsp;file)</CODE>
252
253<BR>
254&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the output XML file</TD>
255</TR>
256<TR BGCOLOR="white" CLASS="TableRowColor">
257<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
258<CODE>protected &nbsp;void</CODE></FONT></TD>
259<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/MMetrics.html#transformFile()">transformFile</A></B>()</CODE>
260
261<BR>
262&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;transform the generated file via the handler
263 This function can either be called if the result is written to the output
264 file via -output or we could use the handler directly on stdout if not.</TD>
265</TR>
266</TABLE>
267&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.optional.metamata.AbstractMetamataTask"><!-- --></A>
268<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
269<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
270<TD><B>Methods inherited from class org.apache.tools.ant.taskdefs.optional.metamata.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html" title="class in org.apache.tools.ant.taskdefs.optional.metamata">AbstractMetamataTask</A></B></TD>
271</TR>
272<TR BGCOLOR="white" CLASS="TableRowColor">
273<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#addAllVector(java.util.Vector, java.util.Enumeration)">addAllVector</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#addFileSet(org.apache.tools.ant.types.FileSet)">addFileSet</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#createClasspath()">createClasspath</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#createJvmarg()">createJvmarg</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#createSourcepath()">createSourcepath</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#createTmpFile()">createTmpFile</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#execute()">execute</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#generateOptionsFile(java.io.File, java.util.Vector)">generateOptionsFile</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#getFileMapping()">getFileMapping</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#getMetamataJar(java.io.File)">getMetamataJar</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#scanSources(java.util.Hashtable)">scanSources</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#scanSources(java.util.Hashtable, java.lang.String[])">scanSources</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#setHome(java.io.File)">setHome</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#setMaxmemory(java.lang.String)">setMaxmemory</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#setMetamatahome(java.io.File)">setMetamatahome</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#setUp()">setUp</A></CODE></TD>
274</TR>
275</TABLE>
276&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
277<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
278<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
279<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
280</TR>
281<TR BGCOLOR="white" CLASS="TableRowColor">
282<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#getDescription()">getDescription</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getLocation()">getLocation</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getOwningTarget()">getOwningTarget</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getRuntimeConfigurableWrapper()">getRuntimeConfigurableWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getTaskName()">getTaskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getTaskType()">getTaskType</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getWrapper()">getWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleErrorFlush(java.lang.String)">handleErrorFlush</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleErrorOutput(java.lang.String)">handleErrorOutput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleFlush(java.lang.String)">handleFlush</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleInput(byte[], int, int)">handleInput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleOutput(java.lang.String)">handleOutput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#init()">init</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#isInvalid()">isInvalid</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String)">log</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#maybeConfigure()">maybeConfigure</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#perform()">perform</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#reconfigure()">reconfigure</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setLocation(org.apache.tools.ant.Location)">setLocation</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setOwningTarget(org.apache.tools.ant.Target)">setOwningTarget</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setRuntimeConfigurableWrapper(org.apache.tools.ant.RuntimeConfigurable)">setRuntimeConfigurableWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setTaskName(java.lang.String)">setTaskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setTaskType(java.lang.String)">setTaskType</A></CODE></TD>
283</TR>
284</TABLE>
285&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
286<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
287<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
288<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
289</TR>
290<TR BGCOLOR="white" CLASS="TableRowColor">
291<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
292</TR>
293</TABLE>
294&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
295<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
296<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
297<TD><B>Methods inherited from class java.lang.Object</B></TD>
298</TR>
299<TR BGCOLOR="white" CLASS="TableRowColor">
300<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
301</TR>
302</TABLE>
303&nbsp;
304<P>
305
306<!-- ============ FIELD DETAIL =========== -->
307
308
309<!-- ========= CONSTRUCTOR DETAIL ======== -->
310
311<A NAME="constructor_detail"><!-- --></A>
312<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
313<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
314<TD COLSPAN=1><FONT SIZE="+2">
315<B>Constructor Detail</B></FONT></TD>
316</TR>
317</TABLE>
318
319<A NAME="MMetrics()"><!-- --></A><H3>
320MMetrics</H3>
321<PRE>
322public <B>MMetrics</B>()</PRE>
323<DL>
324<DD>default constructor
325<P>
326</DL>
327
328<!-- ============ METHOD DETAIL ========== -->
329
330<A NAME="method_detail"><!-- --></A>
331<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
332<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
333<TD COLSPAN=1><FONT SIZE="+2">
334<B>Method Detail</B></FONT></TD>
335</TR>
336</TABLE>
337
338<A NAME="setGranularity(org.apache.tools.ant.taskdefs.optional.metamata.MMetrics.GranularityAttribute)"><!-- --></A><H3>
339setGranularity</H3>
340<PRE>
341public void <B>setGranularity</B>(<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/MMetrics.GranularityAttribute.html" title="class in org.apache.tools.ant.taskdefs.optional.metamata">MMetrics.GranularityAttribute</A>&nbsp;granularity)</PRE>
342<DL>
343<DD>set the granularity of the audit. Should be one of 'files', 'methods'
344 or 'types'.
345<P>
346<DD><DL>
347<DT><B>Parameters:</B><DD><CODE>granularity</CODE> - the audit reporting mode.</DL>
348</DD>
349</DL>
350<HR>
351
352<A NAME="setTofile(java.io.File)"><!-- --></A><H3>
353setTofile</H3>
354<PRE>
355public void <B>setTofile</B>(java.io.File&nbsp;file)</PRE>
356<DL>
357<DD>Set the output XML file
358<P>
359<DD><DL>
360<DT><B>Parameters:</B><DD><CODE>file</CODE> - the xml file to write the XML report to.</DL>
361</DD>
362</DL>
363<HR>
364
365<A NAME="createPath()"><!-- --></A><H3>
366createPath</H3>
367<PRE>
368public <A HREF="../../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> <B>createPath</B>()</PRE>
369<DL>
370<DD>Set a new path (directory) to measure metrics from.
371<P>
372<DD><DL>
373
374<DT><B>Returns:</B><DD>the path instance to use.</DL>
375</DD>
376</DL>
377<HR>
378
379<A NAME="checkOptions()"><!-- --></A><H3>
380checkOptions</H3>
381<PRE>
382protected void <B>checkOptions</B>()
383 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
384<DL>
385<DD><B>Description copied from class: <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html" title="class in org.apache.tools.ant.taskdefs.optional.metamata">AbstractMetamataTask</A></CODE></B></DD>
386<DD>validate options set
387<P>
388<DD><DL>
389<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#checkOptions()">checkOptions</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html" title="class in org.apache.tools.ant.taskdefs.optional.metamata">AbstractMetamataTask</A></CODE></DL>
390</DD>
391<DD><DL>
392
393<DT><B>Throws:</B>
394<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
395</DD>
396</DL>
397<HR>
398
399<A NAME="execute0(org.apache.tools.ant.taskdefs.ExecuteStreamHandler)"><!-- --></A><H3>
400execute0</H3>
401<PRE>
402protected void <B>execute0</B>(<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/ExecuteStreamHandler.html" title="interface in org.apache.tools.ant.taskdefs">ExecuteStreamHandler</A>&nbsp;handler)
403 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
404<DL>
405<DD><B>Description copied from class: <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html" title="class in org.apache.tools.ant.taskdefs.optional.metamata">AbstractMetamataTask</A></CODE></B></DD>
406<DD>execute the process with a specific handler
407<P>
408<DD><DL>
409<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#execute0(org.apache.tools.ant.taskdefs.ExecuteStreamHandler)">execute0</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html" title="class in org.apache.tools.ant.taskdefs.optional.metamata">AbstractMetamataTask</A></CODE></DL>
410</DD>
411<DD><DL>
412
413<DT><B>Throws:</B>
414<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
415</DD>
416</DL>
417<HR>
418
419<A NAME="transformFile()"><!-- --></A><H3>
420transformFile</H3>
421<PRE>
422protected void <B>transformFile</B>()
423 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
424<DL>
425<DD>transform the generated file via the handler
426 This function can either be called if the result is written to the output
427 file via -output or we could use the handler directly on stdout if not.
428<P>
429<DD><DL>
430
431<DT><B>Throws:</B>
432<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/MMetrics.html#createStreamHandler()"><CODE>createStreamHandler()</CODE></A></DL>
433</DD>
434</DL>
435<HR>
436
437<A NAME="cleanUp()"><!-- --></A><H3>
438cleanUp</H3>
439<PRE>
440protected void <B>cleanUp</B>()
441 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
442<DL>
443<DD>cleanup the temporary txt report
444<P>
445<DD><DL>
446<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#cleanUp()">cleanUp</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html" title="class in org.apache.tools.ant.taskdefs.optional.metamata">AbstractMetamataTask</A></CODE></DL>
447</DD>
448<DD><DL>
449
450<DT><B>Throws:</B>
451<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
452</DD>
453</DL>
454<HR>
455
456<A NAME="createStreamHandler()"><!-- --></A><H3>
457createStreamHandler</H3>
458<PRE>
459protected <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/ExecuteStreamHandler.html" title="interface in org.apache.tools.ant.taskdefs">ExecuteStreamHandler</A> <B>createStreamHandler</B>()</PRE>
460<DL>
461<DD>if the report is transform via a temporary txt file we should use a
462 a normal logger here, otherwise we could use the metrics handler
463 directly to capture and transform the output on stdout to XML.
464<P>
465<DD><DL>
466<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#createStreamHandler()">createStreamHandler</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html" title="class in org.apache.tools.ant.taskdefs.optional.metamata">AbstractMetamataTask</A></CODE></DL>
467</DD>
468<DD><DL>
469</DL>
470</DD>
471</DL>
472<HR>
473
474<A NAME="getOptions()"><!-- --></A><H3>
475getOptions</H3>
476<PRE>
477protected java.util.Vector <B>getOptions</B>()</PRE>
478<DL>
479<DD><B>Description copied from class: <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html" title="class in org.apache.tools.ant.taskdefs.optional.metamata">AbstractMetamataTask</A></CODE></B></DD>
480<DD>return all options of the command line as string elements
481<P>
482<DD><DL>
483<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html#getOptions()">getOptions</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/AbstractMetamataTask.html" title="class in org.apache.tools.ant.taskdefs.optional.metamata">AbstractMetamataTask</A></CODE></DL>
484</DD>
485<DD><DL>
486</DL>
487</DD>
488</DL>
489<!-- ========= END OF CLASS DATA ========= -->
490<HR>
491
492
493<!-- ======= START OF BOTTOM NAVBAR ====== -->
494<A NAME="navbar_bottom"><!-- --></A>
495<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
496<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
497<TR>
498<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
499<A NAME="navbar_bottom_firstrow"><!-- --></A>
500<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
501 <TR ALIGN="center" VALIGN="top">
502 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
503 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
504 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
505 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
506 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
507 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
508 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
509 </TR>
510</TABLE>
511</TD>
512<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
513</EM>
514</TD>
515</TR>
516
517<TR>
518<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
519&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/MAudit.html" title="class in org.apache.tools.ant.taskdefs.optional.metamata"><B>PREV CLASS</B></A>&nbsp;
520&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/metamata/MMetrics.GranularityAttribute.html" title="class in org.apache.tools.ant.taskdefs.optional.metamata"><B>NEXT CLASS</B></A></FONT></TD>
521<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
522 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
523&nbsp;<A HREF="MMetrics.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
524&nbsp;<SCRIPT type="text/javascript">
525 <!--
526 if(window==top) {
527 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
528 }
529 //-->
530</SCRIPT>
531<NOSCRIPT>
532 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
533</NOSCRIPT>
534
535</FONT></TD>
536</TR>
537<TR>
538<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
539 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.taskdefs.optional.metamata.AbstractMetamataTask">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
540<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
541DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
542</TR>
543</TABLE>
544<A NAME="skip-navbar_bottom"></A>
545<!-- ======== END OF BOTTOM NAVBAR ======= -->
546
547<HR>
548Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
549</BODY>
550</HTML>
Note: See TracBrowser for help on using the repository browser.