org.apache.tools.ant.types.selectors

Class MappingSelector

public abstract class MappingSelector extends BaseSelector

A mapping selector is an abstract class adding mapping support to the base selector
Field Summary
protected intgranularity
protected FileNameMappermap
protected MappermapperElement
protected Filetargetdir
Constructor Summary
MappingSelector()
Creates a new MappingSelector instance.
Method Summary
MappercreateMapper()
Defines the FileNameMapper to use (nested mapper element).
booleanisSelected(File basedir, String filename, File file)
The heart of the matter.
protected abstract booleanselectionTest(File srcfile, File destfile)
this test is our selection test that compared the file with the destfile
voidsetGranularity(int granularity)
Sets the number of milliseconds leeway we will give before we consider a file out of date.
voidsetTargetdir(File targetdir)
The name of the file or directory which is checked for out-of-date files.
voidverifySettings()
Checks to make sure all settings are kosher.

Field Detail

granularity

protected int granularity

map

protected FileNameMapper map

mapperElement

protected Mapper mapperElement

targetdir

protected File targetdir

Constructor Detail

MappingSelector

public MappingSelector()
Creates a new MappingSelector instance.

Method Detail

createMapper

public Mapper createMapper()
Defines the FileNameMapper to use (nested mapper element).

Returns: a mapper to be configured

Throws: BuildException if more that one mapper defined

isSelected

public boolean isSelected(File basedir, String filename, File file)
The heart of the matter. This is where the selector gets to decide on the inclusion of a file in a particular fileset.

Parameters: basedir the base directory the scan is being done from filename is the name of the file to check file is a java.io.File object the selector can use

Returns: whether the file should be selected or not

selectionTest

protected abstract boolean selectionTest(File srcfile, File destfile)
this test is our selection test that compared the file with the destfile

Parameters: srcfile file to test; may be null destfile destination file

Returns: true if source file compares with destination file

setGranularity

public void setGranularity(int granularity)
Sets the number of milliseconds leeway we will give before we consider a file out of date. Defaults to 2000 on MS-DOS derivatives as the FAT file system.

Parameters: granularity the leeway in milliseconds

setTargetdir

public void setTargetdir(File targetdir)
The name of the file or directory which is checked for out-of-date files.

Parameters: targetdir the directory to scan looking for files.

verifySettings

public void verifySettings()
Checks to make sure all settings are kosher. In this case, it means that the dest attribute has been set and we have a mapper.
Copyright B) 2000-2007 Apache Software Foundation. All Rights Reserved.