Top Description Fields Constructors Methods
org.apache.tools.ant.util

public abstract Class ContainerMapper

extends Object
implements FileNameMapper
Class Inheritance
All Implemented Interfaces
org.apache.tools.ant.util.FileNameMapper
Known Direct Subclasses
org.apache.tools.ant.util.FirstMatchMapper, org.apache.tools.ant.util.ChainedMapper, org.apache.tools.ant.util.CompositeMapper
Imports
java.util.ArrayList, .Collections, .List, org.apache.tools.ant.types.Mapper

A FileNameMapper that contains other FileNameMappers.
See Also
FileNameMapper

Field Summary

Modifier and TypeField and Description
private List<FileNameMapper>

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public synchronized void
add(FileNameMapper
a FileNameMapper.
fileNameMapper
)

Add a FileNameMapper.

public void
addConfigured(FileNameMapper
a FileNameMapper.
fileNameMapper
)

An add configured version of the add method.

public void
addConfiguredMapper(Mapper
the Mapper to add.
mapper
)

Add a Mapper.

protected synchronized boolean

Returns:

boolean.
contains
(FileNameMapper
the FileNameMapper to search for.
fileNameMapper
)

Return true if this ContainerMapper or any of its sub-elements contains the specified FileNameMapper.

public synchronized List<FileNameMapper>

Returns:

List.
getMappers
()

Get the List of FileNameMappers.

public void
setFrom(String
ignored.
ignore
)

Implements org.apache.tools.ant.util.FileNameMapper.setFrom.

Empty implementation.
public void
setTo(String
ignored.
ignore
)

Implements org.apache.tools.ant.util.FileNameMapper.setTo.

Empty implementation.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

mappersback to summary
private List<FileNameMapper> mappers

Constructor Detail

ContainerMapperback to summary
public ContainerMapper()

Method Detail

addback to summary
public synchronized void add(FileNameMapper fileNameMapper)

Add a FileNameMapper.

Parameters
fileNameMapper:FileNameMapper

a FileNameMapper.

Exceptions
IllegalArgumentException:
if attempting to add this ContainerMapper to itself, or if the specified FileNameMapper is itself a ContainerMapper that contains this ContainerMapper.
addConfiguredback to summary
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 addConfigured method has been added to allow chaining to work correctly.

Parameters
fileNameMapper:FileNameMapper

a FileNameMapper.

addConfiguredMapperback to summary
public void addConfiguredMapper(Mapper mapper)

Add a Mapper.

Parameters
mapper:Mapper

the Mapper to add.

containsback to summary
protected synchronized boolean contains(FileNameMapper fileNameMapper)

Return true if this ContainerMapper or any of its sub-elements contains the specified FileNameMapper.

Parameters
fileNameMapper:FileNameMapper

the FileNameMapper to search for.

Returns:boolean

boolean.

getMappersback to summary
public synchronized List<FileNameMapper> getMappers()

Get the List of FileNameMappers.

Returns:List<FileNameMapper>

List.

setFromback to summary
public void setFrom(String ignore)

Implements org.apache.tools.ant.util.FileNameMapper.setFrom.

Empty implementation.

Parameters
ignore:String

ignored.

Annotations
@Override
setToback to summary
public void setTo(String ignore)

Implements org.apache.tools.ant.util.FileNameMapper.setTo.

Empty implementation.

Parameters
ignore:String

ignored.

Annotations
@Override