Package org.apache.tools.ant.types
Class Mapper
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.Mapper
- All Implemented Interfaces:
- Cloneable
Element to define a FileNameMapper.
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic classClass as Argument to FileNameMapper.setType.
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected Stringprotected Pathprotected Stringprotected Stringprotected Mapper.MapperTypeFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidadd(FileNameMapper fileNameMapper) Add a nestedFileNameMapper.voidaddConfigured(FileNameMapper fileNameMapper) Cannot mix add and addconfigured in same type, so provide this to override the add method.voidaddConfiguredMapper(Mapper mapper) Add a MapperSet the classpath to load the FileNameMapper through (nested element).Returns a fully configured FileNameMapper implementation.protected Class<? extends FileNameMapper>Gets the Class object associated with the mapper implementation.protected MappergetRef()Deprecated.since Ant 1.7.1 because a mapper might ref a FileNameMapper implementation directly.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 ref) Set the classpath to load the FileNameMapper through via reference (attribute).voidSet the argument to FileNameMapper.setFromvoidMake this Mapper instance a reference to another Mapper.voidSet the argument to FileNameMapper.setTovoidsetType(Mapper.MapperType type) Set the type ofFileNameMapperto use.Methods inherited from class org.apache.tools.ant.types.DataTypecheckAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes, toStringMethods inherited from class org.apache.tools.ant.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
- 
Field Details- 
type
- 
classname
- 
classpath
- 
from
- 
to
 
- 
- 
Constructor Details- 
MapperConstruct a newMapperelement.- Parameters:
- p- the owning Ant- Project.
 
 
- 
- 
Method Details- 
setTypeSet the type ofFileNameMapperto use.- Parameters:
- type- the- MapperTypeenumerated attribute.
 
- 
addConfiguredCannot mix add and addconfigured in same type, so provide this to override the add method.- Parameters:
- fileNameMapper- the- FileNameMapperto add.
 
- 
addAdd a nestedFileNameMapper.- Parameters:
- fileNameMapper- the- FileNameMapperto add.
 
- 
addConfiguredMapperAdd a Mapper- Parameters:
- mapper- the mapper to add
 
- 
setClassnameSet the class name of the FileNameMapper to use.- Parameters:
- classname- the name of the class
 
- 
setClasspathSet the classpath to load the FileNameMapper through (attribute).- Parameters:
- classpath- the classpath
 
- 
createClasspathSet the classpath to load the FileNameMapper through (nested element).- Returns:
- a path object to be configured
 
- 
setClasspathRefSet the classpath to load the FileNameMapper through via reference (attribute).- Parameters:
- ref- the reference to the FileNameMapper
 
- 
setFromSet the argument to FileNameMapper.setFrom- Parameters:
- from- the from attribute to pass to the FileNameMapper
 
- 
setToSet the argument to FileNameMapper.setTo- Parameters:
- to- the to attribute to pass to the FileNameMapper
 
- 
setRefidMake this Mapper instance a reference to another Mapper.You must not set any other attribute if you make it a reference. - Overrides:
- setRefidin class- DataType
- Parameters:
- r- the reference to another mapper
- Throws:
- BuildException- if other attributes are set
 
- 
getImplementationReturns a fully configured FileNameMapper implementation.- Returns:
- a FileNameMapper object to be configured
- Throws:
- BuildException- on error
 
- 
getImplementationClassGets the Class object associated with the mapper implementation.- Returns:
- Class.
- Throws:
- ClassNotFoundException- if the class cannot be found
 
- 
getRefDeprecated.since Ant 1.7.1 because a mapper might ref a FileNameMapper implementation directly.Performs the check for circular references and returns the referenced Mapper.- Returns:
- the referenced Mapper
 
 
-