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
public class Mapper extends DataType
Element to define a FileNameMapper.

  • Field Details

  • Constructor Details

    • Mapper

      public Mapper(Project p)
      Construct a new Mapper element.
      Parameters:
      p - the owning Ant Project.

  • Method Details

    • setType

      public void setType(Mapper.MapperType type)
      Set the type of FileNameMapper to use.
      Parameters:
      type - the MapperType enumerated attribute.

    • addConfigured

      public void addConfigured(FileNameMapper fileNameMapper)
      Cannot mix add and addconfigured in same type, so provide this to override the add method.
      Parameters:
      fileNameMapper - the FileNameMapper to add.

    • 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

    • setClassname

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

    • setClasspath

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

    • createClasspath

      public Path createClasspath()
      Set the classpath to load the FileNameMapper through (nested element).
      Returns:
      a path object to be configured

    • setClasspathRef

      public void setClasspathRef(Reference ref)
      Set the classpath to load the FileNameMapper through via reference (attribute).
      Parameters:
      ref - the reference to the FileNameMapper

    • setFrom

      public void setFrom(String from)
      Set the argument to FileNameMapper.setFrom
      Parameters:
      from - the from attribute to pass to the FileNameMapper

    • setTo

      public void setTo(String to)
      Set the argument to FileNameMapper.setTo
      Parameters:
      to - the to attribute to pass to the FileNameMapper

    • setRefid

      public 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:
      setRefid in class DataType
      Parameters:
      r - the reference to another mapper
      Throws:
      BuildException - if other attributes are set

    • getImplementation

      public FileNameMapper getImplementation() throws BuildException
      Returns a fully configured FileNameMapper implementation.
      Returns:
      a FileNameMapper object to be configured
      Throws:
      BuildException - on error

    • getImplementationClass

      protected Class<? extends FileNameMapper> getImplementationClass() throws ClassNotFoundException
      Gets the Class object associated with the mapper implementation.
      Returns:
      Class.
      Throws:
      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