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 Summary
Nested ClassesModifier and TypeClassDescriptionstatic classClass as Argument to FileNameMapper.setType. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Stringprotected Pathprotected Stringprotected Stringprotected Mapper.MapperTypeFields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
Constructors -
Method Summary
Modifier 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.DataType
checkAttributesAllowed, 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.ProjectComponent
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
-
Field Details
-
type
-
classname
-
classpath
-
from
-
to
-
-
Constructor Details
-
Mapper
Construct a newMapperelement.- Parameters:
p- the owning AntProject.
-
-
Method Details
-
setType
Set the type ofFileNameMapperto use.- Parameters:
type- theMapperTypeenumerated attribute.
-
addConfigured
Cannot mix add and addconfigured in same type, so provide this to override the add method.- Parameters:
fileNameMapper- theFileNameMapperto add.
-
add
Add a nestedFileNameMapper.- Parameters:
fileNameMapper- theFileNameMapperto add.
-
addConfiguredMapper
Add a Mapper- Parameters:
mapper- the mapper to add
-
setClassname
Set the class name of the FileNameMapper to use.- Parameters:
classname- the name of the class
-
setClasspath
Set the classpath to load the FileNameMapper through (attribute).- Parameters:
classpath- the classpath
-
createClasspath
Set the classpath to load the FileNameMapper through (nested element).- Returns:
- a path object to be configured
-
setClasspathRef
Set the classpath to load the FileNameMapper through via reference (attribute).- Parameters:
ref- the reference to the FileNameMapper
-
setFrom
Set the argument to FileNameMapper.setFrom- Parameters:
from- the from attribute to pass to the FileNameMapper
-
setTo
Set the argument to FileNameMapper.setTo- Parameters:
to- the to attribute to pass to the FileNameMapper
-
setRefid
Make this Mapper instance a reference to another Mapper.You must not set any other attribute if you make it a reference.
- Overrides:
setRefidin classDataType- Parameters:
r- the reference to another mapper- Throws:
BuildException- if other attributes are set
-
getImplementation
Returns a fully configured FileNameMapper implementation.- Returns:
- a FileNameMapper object to be configured
- Throws:
BuildException- on error
-
getImplementationClass
Gets the Class object associated with the mapper implementation.- Returns:
Class.- Throws:
ClassNotFoundException- if the class cannot be found
-
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
-