org.apache.tools.ant.types

Class Mapper

public class Mapper extends DataType implements Cloneable

Element to define a FileNameMapper.
Nested Class Summary
static classMapper.MapperType
Class as Argument to FileNameMapper.setType.
Field Summary
protected Stringclassname
protected Pathclasspath
protected Stringfrom
protected Stringto
protected Mapper.MapperTypetype
Constructor Summary
Mapper(Project p)
Construct a new Mapper element.
Method Summary
voidadd(FileNameMapper fileNameMapper)
Add a nested FileNameMapper.
voidaddConfiguredMapper(Mapper mapper)
Add a Mapper
PathcreateClasspath()
Set the classpath to load the FileNameMapper through (nested element).
FileNameMappergetImplementation()
Returns a fully configured FileNameMapper implementation.
protected ClassgetImplementationClass()
Gets the Class object associated with the mapper implementation.
protected MappergetRef()
Performs the check for circular references and returns the referenced Mapper.
voidsetClassname(String classname)
Set the class name of the FileNameMapper to use.
voidsetClasspath(Path classpath)
Set the classpath to load the FileNameMapper through (attribute).
voidsetClasspathRef(Reference r)
Set the classpath to load the FileNameMapper through via reference (attribute).
voidsetFrom(String from)
Set the argument to FileNameMapper.setFrom
voidsetRefid(Reference r)
Make this Mapper instance a reference to another Mapper.
voidsetTo(String to)
Set the argument to FileNameMapper.setTo
voidsetType(Mapper.MapperType type)
Set the type of FileNameMapper to use.

Field Detail

classname

protected String classname

classpath

protected Path classpath

from

protected String from

to

protected String to

type

protected Mapper.MapperType type

Constructor Detail

Mapper

public Mapper(Project p)
Construct a new Mapper element.

Parameters: p the owning Ant Project.

Method Detail

add

public void add(FileNameMapper fileNameMapper)
Add a nested FileNameMapper.

Parameters: fileNameMapper the FileNameMapper to add.

addConfiguredMapper

public void addConfiguredMapper(Mapper mapper)
Add a Mapper

Parameters: mapper the mapper to add

createClasspath

public Path createClasspath()
Set the classpath to load the FileNameMapper through (nested element).

getImplementation

public FileNameMapper getImplementation()
Returns a fully configured FileNameMapper implementation.

getImplementationClass

protected Class getImplementationClass()
Gets the Class object associated with the mapper implementation.

Returns: Class.

getRef

protected Mapper getRef()
Performs the check for circular references and returns the referenced Mapper.

setClassname

public void setClassname(String classname)
Set the class name of the FileNameMapper to use.

setClasspath

public void setClasspath(Path classpath)
Set the classpath to load the FileNameMapper through (attribute).

setClasspathRef

public void setClasspathRef(Reference r)
Set the classpath to load the FileNameMapper through via reference (attribute).

setFrom

public void setFrom(String from)
Set the argument to FileNameMapper.setFrom

setRefid

public void setRefid(Reference r)
Make this Mapper instance a reference to another Mapper.

You must not set any other attribute if you make it a reference.

setTo

public void setTo(String to)
Set the argument to FileNameMapper.setTo

setType

public void setType(Mapper.MapperType type)
Set the type of FileNameMapper to use.

Parameters: type the MapperType enumerated attribute.

Copyright