| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.Mapper
public class Mapper
Element to define a FileNameMapper.
| Nested Class Summary | |
|---|---|
| static class | Mapper.MapperTypeClass as Argument to FileNameMapper.setType. | 
| Field Summary | |
|---|---|
| protected  java.lang.String | classname | 
| protected  Path | classpath | 
| protected  java.lang.String | from | 
| protected  java.lang.String | to | 
| protected  Mapper.MapperType | type | 
| Fields inherited from class org.apache.tools.ant.types.DataType | 
|---|
| checked, ref | 
| Fields inherited from class org.apache.tools.ant.ProjectComponent | 
|---|
| description, location, project | 
| Constructor Summary | |
|---|---|
| Mapper(Project p)Construct a new Mapperelement. | |
| Method Summary | |
|---|---|
|  void | add(FileNameMapper fileNameMapper)Add a nested FileNameMapper. | 
|  void | addConfigured(FileNameMapper fileNameMapper)Cannot mix add and addconfigured in same type, so provide this to override the add method. | 
|  void | addConfiguredMapper(Mapper mapper)Add a Mapper | 
|  Path | createClasspath()Set the classpath to load the FileNameMapper through (nested element). | 
|  FileNameMapper | getImplementation()Returns a fully configured FileNameMapper implementation. | 
| protected  java.lang.Class<? extends FileNameMapper> | getImplementationClass()Gets the Class object associated with the mapper implementation. | 
| protected  Mapper | getRef()Deprecated. since Ant 1.7.1 because a mapper might ref a FileNameMapper implementation directly. | 
|  void | setClassname(java.lang.String classname)Set the class name of the FileNameMapper to use. | 
|  void | setClasspath(Path classpath)Set the classpath to load the FileNameMapper through (attribute). | 
|  void | setClasspathRef(Reference ref)Set the classpath to load the FileNameMapper through via reference (attribute). | 
|  void | setFrom(java.lang.String from)Set the argument to FileNameMapper.setFrom | 
|  void | setRefid(Reference r)Make this Mapper instance a reference to another Mapper. | 
|  void | setTo(java.lang.String to)Set the argument to FileNameMapper.setTo | 
|  void | setType(Mapper.MapperType type)Set the type of FileNameMapperto use. | 
| Methods inherited from class org.apache.tools.ant.types.DataType | 
|---|
| checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes, toString | 
| Methods inherited from class org.apache.tools.ant.ProjectComponent | 
|---|
| getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject | 
| Methods inherited from class java.lang.Object | 
|---|
| equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait | 
| Field Detail | 
|---|
protected Mapper.MapperType type
protected java.lang.String classname
protected Path classpath
protected java.lang.String from
protected java.lang.String to
| Constructor Detail | 
|---|
public Mapper(Project p)
Mapper element.
p - the owning Ant Project.| Method Detail | 
|---|
public void setType(Mapper.MapperType type)
FileNameMapper to use.
type - the MapperType enumerated attribute.public void addConfigured(FileNameMapper fileNameMapper)
fileNameMapper - the FileNameMapper to add.public void add(FileNameMapper fileNameMapper)
FileNameMapper.
fileNameMapper - the FileNameMapper to add.public void addConfiguredMapper(Mapper mapper)
mapper - the mapper to addpublic void setClassname(java.lang.String classname)
classname - the name of the classpublic void setClasspath(Path classpath)
classpath - the classpathpublic Path createClasspath()
public void setClasspathRef(Reference ref)
ref - the reference to the FileNameMapperpublic void setFrom(java.lang.String from)
from - the from attribute to pass to the FileNameMapperpublic void setTo(java.lang.String to)
to - the to attribute to pass to the FileNameMapper
public void setRefid(Reference r)
              throws BuildException
You must not set any other attribute if you make it a reference.
setRefid in class DataTyper - the reference to another mapper
BuildException - if other attributes are set
public FileNameMapper getImplementation()
                                 throws BuildException
BuildException - on error
protected java.lang.Class<? extends FileNameMapper> getImplementationClass()
                                                                    throws java.lang.ClassNotFoundException
Class.
java.lang.ClassNotFoundException - if the class cannot be foundprotected Mapper getRef()
| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||