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:
- java.lang.Cloneable
 
 public class Mapper extends DataType Element to define a FileNameMapper.
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classMapper.MapperTypeClass as Argument to FileNameMapper.setType.
 - 
Field SummaryFields Modifier and Type Field Description protected java.lang.Stringclassnameprotected Pathclasspathprotected java.lang.Stringfromprotected java.lang.Stringtoprotected Mapper.MapperTypetype- 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Method SummaryModifier and Type Method Description voidadd(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 MapperPathcreateClasspath()Set the classpath to load the FileNameMapper through (nested element).FileNameMappergetImplementation()Returns a fully configured FileNameMapper implementation.protected java.lang.Class<? extends FileNameMapper>getImplementationClass()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(java.lang.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).voidsetFrom(java.lang.String from)Set the argument to FileNameMapper.setFromvoidsetRefid(Reference r)Make this Mapper instance a reference to another Mapper.voidsetTo(java.lang.String to)Set 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, toString
 - 
Methods inherited from class org.apache.tools.ant.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
 
- 
 
- 
- 
- 
Field Detail- 
typeprotected Mapper.MapperType type 
 - 
classnameprotected java.lang.String classname 
 - 
classpathprotected Path classpath 
 - 
fromprotected java.lang.String from 
 - 
toprotected java.lang.String to 
 
- 
 - 
Constructor Detail- 
Mapperpublic Mapper(Project p) Construct a newMapperelement.- Parameters:
- p- the owning Ant- Project.
 
 
- 
 - 
Method Detail- 
setTypepublic void setType(Mapper.MapperType type) Set the type ofFileNameMapperto use.- Parameters:
- type- the- MapperTypeenumerated attribute.
 
 - 
addConfiguredpublic void addConfigured(FileNameMapper fileNameMapper) Cannot mix add and addconfigured in same type, so provide this to override the add method.- Parameters:
- fileNameMapper- the- FileNameMapperto add.
 
 - 
addpublic void add(FileNameMapper fileNameMapper) Add a nestedFileNameMapper.- Parameters:
- fileNameMapper- the- FileNameMapperto add.
 
 - 
addConfiguredMapperpublic void addConfiguredMapper(Mapper mapper) Add a Mapper- Parameters:
- mapper- the mapper to add
 
 - 
setClassnamepublic void setClassname(java.lang.String classname) Set the class name of the FileNameMapper to use.- Parameters:
- classname- the name of the class
 
 - 
setClasspathpublic void setClasspath(Path classpath) Set the classpath to load the FileNameMapper through (attribute).- Parameters:
- classpath- the classpath
 
 - 
createClasspathpublic Path createClasspath() Set the classpath to load the FileNameMapper through (nested element).- Returns:
- a path object to be configured
 
 - 
setClasspathRefpublic void setClasspathRef(Reference ref) Set the classpath to load the FileNameMapper through via reference (attribute).- Parameters:
- ref- the reference to the FileNameMapper
 
 - 
setFrompublic void setFrom(java.lang.String from) Set the argument to FileNameMapper.setFrom- Parameters:
- from- the from attribute to pass to the FileNameMapper
 
 - 
setTopublic void setTo(java.lang.String to) Set the argument to FileNameMapper.setTo- Parameters:
- to- the to attribute to pass to the FileNameMapper
 
 - 
setRefidpublic void setRefid(Reference r) throws BuildException Make 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
 
 - 
getImplementationpublic FileNameMapper getImplementation() throws BuildException Returns a fully configured FileNameMapper implementation.- Returns:
- a FileNameMapper object to be configured
- Throws:
- BuildException- on error
 
 - 
getImplementationClassprotected java.lang.Class<? extends FileNameMapper> getImplementationClass() throws java.lang.ClassNotFoundException Gets the Class object associated with the mapper implementation.- Returns:
- Class.
- Throws:
- java.lang.ClassNotFoundException- if the class cannot be found
 
 - 
getRef@Deprecated protected Mapper getRef() Deprecated.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
 
 
- 
 
-