org.apache.tools.ant.util

Class ContainerMapper

Implemented Interfaces:
FileNameMapper
Known Direct Subclasses:
ChainedMapper, CompositeMapper

public abstract class ContainerMapper
extends java.lang.Object
implements FileNameMapper

A FileNameMapper that contains other FileNameMappers.
See Also:
FileNameMapper

Method Summary

void
add(FileNameMapper fileNameMapper)
Add a FileNameMapper.
void
addConfigured(FileNameMapper fileNameMapper)
An add configured version of the add method.
void
addConfiguredMapper(Mapper mapper)
Add a Mapper.
protected boolean
contains(FileNameMapper fileNameMapper)
Return true if this ContainerMapper or any of its sub-elements contains the specified FileNameMapper.
List
getMappers()
Get the List of FileNameMappers.
void
setFrom(String ignore)
Empty implementation.
void
setTo(String ignore)
Empty implementation.

Method Details

add

public void add(FileNameMapper fileNameMapper)
Add a FileNameMapper.
Parameters:
fileNameMapper - a FileNameMapper.

addConfigured

public void addConfigured(FileNameMapper fileNameMapper)
An add configured version of the add method. This class used to contain an add method and an addConfiguredMapper method. Dur to ordering, the add method was always called first. This addConfigued method has been added to allow chaining to work correctly.
Parameters:
fileNameMapper - a FileNameMapper.

addConfiguredMapper

public void addConfiguredMapper(Mapper mapper)
Add a Mapper.
Parameters:
mapper - the Mapper to add.

contains

protected boolean contains(FileNameMapper fileNameMapper)
Return true if this ContainerMapper or any of its sub-elements contains the specified FileNameMapper.
Parameters:
fileNameMapper - the FileNameMapper to search for.
Returns:
boolean.

getMappers

public List getMappers()
Get the List of FileNameMappers.
Returns:
List.

setFrom

public void setFrom(String ignore)
Empty implementation.
Specified by:
setFrom in interface FileNameMapper
Parameters:
ignore - ignored.

setTo

public void setTo(String ignore)
Empty implementation.
Specified by:
setTo in interface FileNameMapper
Parameters:
ignore - ignored.