org.apache.tools.ant.types.selectors

Class MappingSelector

Implemented Interfaces:
FileSelector
Known Direct Subclasses:
DependSelector, DifferentSelector

public abstract class MappingSelector
extends BaseSelector

A mapping selector is an abstract class adding mapping support to the base selector

Field Summary

protected int
granularity
protected FileNameMapper
map
protected Mapper
mapperElement
protected File
targetdir

Fields inherited from class org.apache.tools.ant.types.DataType

checked, description, ref

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

MappingSelector()
Creates a new MappingSelector instance.

Method Summary

Mapper
createMapper()
Defines the FileNameMapper to use (nested mapper element).
boolean
isSelected(File basedir, String filename, File file)
The heart of the matter.
protected boolean
selectionTest(File srcfile, File destfile)
this test is our selection test that compared the file with the destfile
void
setGranularity(int granularity)
Sets the number of milliseconds leeway we will give before we consider a file out of date.
void
setTargetdir(File targetdir)
The name of the file or directory which is checked for out-of-date files.
void
verifySettings()
Checks to make sure all settings are kosher.

Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector

getError, isSelected, setError, validate, verifySettings

Methods inherited from class org.apache.tools.ant.types.DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, getCheckedRef, getDescription, getRefid, isChecked, isReference, noChildrenAllowed, setChecked, setDescription, setRefid, tooManyAttributes

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Field Details

granularity

protected int granularity


map

protected FileNameMapper map


mapperElement

protected Mapper mapperElement


targetdir

protected File targetdir

Constructor Details

MappingSelector

public MappingSelector()
Creates a new MappingSelector instance.

Method Details

createMapper

public Mapper createMapper()
            throws BuildException
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.
Specified by:
isSelected in interface FileSelector
Overrides:
isSelected in interface BaseSelector

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 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.
Overrides:
verifySettings in interface BaseSelector


Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.