Edit C:\apache-ant-1.8.0\docs\manual\api\org\apache\tools\ant\util\SourceFileScanner.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<HTML>
<HEAD>

<TITLE>
SourceFileScanner (Apache Ant API)
</TITLE>

<SCRIPT type="text/javascript">
function windowTitle()
{
 parent.document.title="SourceFileScanner (Apache Ant API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<A NAME="navbar_top"></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 <TR ALIGN="center" VALIGN="top">
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>

</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2">
&nbsp;<A HREF="../../../../../org/apache/tools/ant/util/ScriptRunnerHelper.html" title="class in org.apache.tools.ant.util">PREV CLASS</A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/tools/ant/util/SplitClassLoader.html" title="class in org.apache.tools.ant.util">NEXT CLASS</A></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
 <A HREF="../../../../../index.html?org/apache/tools/ant/util/SourceFileScanner.html" target="_top">FRAMES</A> &nbsp;
&nbsp;<A HREF="SourceFileScanner.html" target="_top">NO FRAMES</A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
 
</SCRIPT>
<NOSCRIPT>
 <A HREF="../../../../../allclasses-noframe.html">All Classes</A>
</NOSCRIPT>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>

<HR>

<H2>

org.apache.tools.ant.util
 
Class SourceFileScanner</H2>
<PRE>
java.lang.Object
 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">org.apache.tools.ant.util.SourceFileScanner
</PRE>
<DL>
<DT>All Implemented Interfaces: <DD><A HREF="../../../../../org/apache/tools/ant/types/ResourceFactory.html" title="interface in org.apache.tools.ant.types">ResourceFactory</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class SourceFileScanner<DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/apache/tools/ant/types/ResourceFactory.html" title="interface in org.apache.tools.ant.types">ResourceFactory</A></DL>
</PRE>

Utility class that collects the functionality of the various
 scanDir methods that have been scattered in several tasks before.

The only method returns an array of source files. The array is a
 subset of the files given as a parameter and holds only those that
 are newer than their corresponding target files.

<HR>

<A NAME="field_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2">
Field Summary</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>protected &nbsp;<A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/util/SourceFileScanner.html#task">task</A></CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;

<A NAME="constructor_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2">
Constructor Summary</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/util/SourceFileScanner.html#SourceFileScanner(org.apache.tools.ant.Task)">SourceFileScanner</A>(<A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A>&nbsp;task)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a new SourceFileScanner.</TD>
</TR>
</TABLE>
&nbsp;

<A NAME="method_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2">
Method Summary</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Resource.html" title="class in org.apache.tools.ant.types">Resource</A></CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/util/SourceFileScanner.html#getResource(java.lang.String)">getResource</A>(java.lang.String&nbsp;name)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns resource information for a file at destination.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;java.lang.String[]</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/util/SourceFileScanner.html#restrict(java.lang.String[], java.io.File, java.io.File, org.apache.tools.ant.util.FileNameMapper)">restrict</A>(java.lang.String[]&nbsp;files,
 java.io.File&nbsp;srcDir,
 java.io.File&nbsp;destDir,
 <A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A>&nbsp;mapper)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Restrict the given set of files to those that are newer than
 their corresponding target files.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;java.lang.String[]</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/util/SourceFileScanner.html#restrict(java.lang.String[], java.io.File, java.io.File, org.apache.tools.ant.util.FileNameMapper, long)">restrict</A>(java.lang.String[]&nbsp;files,
 java.io.File&nbsp;srcDir,
 java.io.File&nbsp;destDir,
 <A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A>&nbsp;mapper,
 long&nbsp;granularity)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Restrict the given set of files to those that are newer than
 their corresponding target files.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;java.io.File[]</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/util/SourceFileScanner.html#restrictAsFiles(java.lang.String[], java.io.File, java.io.File, org.apache.tools.ant.util.FileNameMapper)">restrictAsFiles</A>(java.lang.String[]&nbsp;files,
 java.io.File&nbsp;srcDir,
 java.io.File&nbsp;destDir,
 <A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A>&nbsp;mapper)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convenience layer on top of restrict that returns the source
 files as File objects (containing absolute paths if srcDir is
 absolute).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;java.io.File[]</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/util/SourceFileScanner.html#restrictAsFiles(java.lang.String[], java.io.File, java.io.File, org.apache.tools.ant.util.FileNameMapper, long)">restrictAsFiles</A>(java.lang.String[]&nbsp;files,
 java.io.File&nbsp;srcDir,
 java.io.File&nbsp;destDir,
 <A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A>&nbsp;mapper,
 long&nbsp;granularity)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convenience layer on top of restrict that returns the source
 files as File objects (containing absolute paths if srcDir is
 absolute).</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left">Methods inherited from class java.lang.Object</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;

<A NAME="field_detail"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1">
Field Detail</TH>
</TR>
</TABLE>

<A NAME="task"></A><H3>
task</H3>
<PRE>
protected <A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A> task</PRE>
<DL>
<DL>
</DL>
</DL>

<A NAME="constructor_detail"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1">
Constructor Detail</TH>
</TR>
</TABLE>

<A NAME="SourceFileScanner(org.apache.tools.ant.Task)"></A><H3>
SourceFileScanner</H3>
<PRE>
public SourceFileScanner(<A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A>&nbsp;task)</PRE>
<DL>
<DD>Construct a new SourceFileScanner.

<DL>
<DT>Parameters:<DD><CODE>task</CODE> - The task we should log messages through.</DL>
</DL>

<A NAME="method_detail"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1">
Method Detail</TH>
</TR>
</TABLE>

<A NAME="restrict(java.lang.String[], java.io.File, java.io.File, org.apache.tools.ant.util.FileNameMapper)"></A><H3>
restrict</H3>
<PRE>
public java.lang.String[] restrict(java.lang.String[]&nbsp;files,
 java.io.File&nbsp;srcDir,
 java.io.File&nbsp;destDir,
 <A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A>&nbsp;mapper)</PRE>
<DL>
<DD>Restrict the given set of files to those that are newer than
 their corresponding target files.

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>files</CODE> - the original set of files.<DD><CODE>srcDir</CODE> - all files are relative to this directory.<DD><CODE>destDir</CODE> - target files live here. if null file names
 returned by the mapper are assumed to be absolute.<DD><CODE>mapper</CODE> - knows how to construct a target file names from
 source file names.
<DT>Returns:<DD>an array of filenames.</DL>
</DD>
</DL>
<HR>

<A NAME="restrict(java.lang.String[], java.io.File, java.io.File, org.apache.tools.ant.util.FileNameMapper, long)"></A><H3>
restrict</H3>
<PRE>
public java.lang.String[] restrict(java.lang.String[]&nbsp;files,
 java.io.File&nbsp;srcDir,
 java.io.File&nbsp;destDir,
 <A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A>&nbsp;mapper,
 long&nbsp;granularity)</PRE>
<DL>
<DD>Restrict the given set of files to those that are newer than
 their corresponding target files.

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>files</CODE> - the original set of files.<DD><CODE>srcDir</CODE> - all files are relative to this directory.<DD><CODE>destDir</CODE> - target files live here. If null file names
 returned by the mapper are assumed to be absolute.<DD><CODE>mapper</CODE> - knows how to construct a target file names from
 source file names.<DD><CODE>granularity</CODE> - The number of milliseconds leeway to give
 before deciding a target is out of date.
<DT>Returns:<DD>an array of filenames.<DT>Since:</DT>
 <DD>Ant 1.6.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="restrictAsFiles(java.lang.String[], java.io.File, java.io.File, org.apache.tools.ant.util.FileNameMapper)"></A><H3>
restrictAsFiles</H3>
<PRE>
public java.io.File[] restrictAsFiles(java.lang.String[]&nbsp;files,
 java.io.File&nbsp;srcDir,
 java.io.File&nbsp;destDir,
 <A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A>&nbsp;mapper)</PRE>
<DL>
<DD>Convenience layer on top of restrict that returns the source
 files as File objects (containing absolute paths if srcDir is
 absolute).

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>files</CODE> - the original set of files.<DD><CODE>srcDir</CODE> - all files are relative to this directory.<DD><CODE>destDir</CODE> - target files live here. If null file names
 returned by the mapper are assumed to be absolute.<DD><CODE>mapper</CODE> - knows how to construct a target file names from
 source file names.
<DT>Returns:<DD>an array of files.</DL>
</DD>
</DL>
<HR>

<A NAME="restrictAsFiles(java.lang.String[], java.io.File, java.io.File, org.apache.tools.ant.util.FileNameMapper, long)"></A><H3>
restrictAsFiles</H3>
<PRE>
public java.io.File[] restrictAsFiles(java.lang.String[]&nbsp;files,
 java.io.File&nbsp;srcDir,
 java.io.File&nbsp;destDir,
 <A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A>&nbsp;mapper,
 long&nbsp;granularity)</PRE>
<DL>
<DD>Convenience layer on top of restrict that returns the source
 files as File objects (containing absolute paths if srcDir is
 absolute).

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>files</CODE> - the original set of files.<DD><CODE>srcDir</CODE> - all files are relative to this directory.<DD><CODE>destDir</CODE> - target files live here. If null file names
 returned by the mapper are assumed to be absolute.<DD><CODE>mapper</CODE> - knows how to construct a target file names from
 source file names.<DD><CODE>granularity</CODE> - The number of milliseconds leeway to give
 before deciding a target is out of date.
<DT>Returns:<DD>an array of files.<DT>Since:</DT>
 <DD>Ant 1.6.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getResource(java.lang.String)"></A><H3>
getResource</H3>
<PRE>
public <A HREF="../../../../../org/apache/tools/ant/types/Resource.html" title="class in org.apache.tools.ant.types">Resource</A> getResource(java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Returns resource information for a file at destination.

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../../../org/apache/tools/ant/types/ResourceFactory.html#getResource(java.lang.String)">getResource</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/tools/ant/types/ResourceFactory.html" title="interface in org.apache.tools.ant.types">ResourceFactory</A></CODE></DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>name</CODE> - relative path of file at destination.
<DT>Returns:<DD>data concerning a file whose relative path to destDir is name.<DT>Since:</DT>
 <DD>Ant 1.5.2</DD>
</DL>
</DD>
</DL>

<HR>

<A NAME="navbar_bottom"></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 <TR ALIGN="center" VALIGN="top">
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>

</TD>
</TR>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>

<HR>

</BODY>
</HTML>

Ms-Dos/Windows Unix Write backup

jsp File Browser version 1.2 by www.vonloesch.de