CopyPath (Apache Ant API)

Overview | Package | Class | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.tools.ant.taskdefs
Class CopyPath

    java.lang.Object
      org.apache.tools.ant.ProjectComponent
          org.apache.tools.ant.Task
              org.apache.tools.ant.taskdefs.CopyPath

All Implemented Interfaces:
  java.lang.Cloneable

    public class CopyPath

extends Task

Copy the contents of a path to a destination, using the mapper of choice

Since:
  Ant 1.7

Field Summary
`static java.lang.String` | `ERROR_NO_DESTDIR` No destdir attribute
`static java.lang.String` | `ERROR_NO_MAPPER` No mapper
`static java.lang.String` | `ERROR_NO_PATH` No path

Fields inherited from class org.apache.tools.ant.Task
`target, taskName, taskType, wrapper`

Fields inherited from class org.apache.tools.ant.ProjectComponent
`description, location, project`

Constructor Summary
`CopyPath()`

Method Summary
`void` | `add(FileNameMapper newmapper)` add a mapper
`Path` | `createPath()` Create a path.
`void` | `execute()` This is a very minimal derivative of the nomal copy logic.
`void` | `setDestDir(java.io.File destDir)` The dest dir attribute.
`void` | `setGranularity(long granularity)` Set the number of milliseconds leeway to give before deciding a target is out of date.
`void` | `setPath(Path s)` Set the path to be used when running the Java class.
`void` | `setPathRef(Reference r)` Set the path to use by reference.
`void` | `setPreserveLastModified(boolean preserveLastModified)` Give the copied files the same last modified time as the original files.
`protected void` | `validateAttributes()` Ensure we have a consistent and legal set of attributes, and set any internal flags necessary based on different combinations of attributes.

Methods inherited from class org.apache.tools.ant.Task
`bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType`

Methods inherited from class org.apache.tools.ant.ProjectComponent
`clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject`

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### ERROR_NO_DESTDIR

    public static final java.lang.String ERROR_NO_DESTDIR

  No destdir attribute

  See Also:
    Constant Field Values

### ERROR_NO_PATH

    public static final java.lang.String ERROR_NO_PATH

  No path

  See Also:
    Constant Field Values

### ERROR_NO_MAPPER

    public static final java.lang.String ERROR_NO_MAPPER

  No mapper

  See Also:
    Constant Field Values

Constructor Detail

### CopyPath

    public CopyPath()

Method Detail

### setDestDir

    public void setDestDir(java.io.File destDir)

  The dest dir attribute.

  Parameters:
    `destDir` - the value of the destdir attribute.

### add

    public void add(FileNameMapper newmapper)

  add a mapper

  Parameters:
    `newmapper` - the mapper to add.

### setPath

    public void setPath(Path s)

  Set the path to be used when running the Java class.

  Parameters:
    `s` - an Ant Path object containing the path.

### setPathRef

    public void setPathRef(Reference r)

  Set the path to use by reference.

  Parameters:
    `r` - a reference to an existing path.

### createPath

    public Path createPath()

  Create a path.

  Returns:
    a path to be configured.

### setGranularity

    public void setGranularity(long granularity)

  Set the number of milliseconds leeway to give before deciding a target is out of date. TODO: This is not yet used.

  Parameters:
    `granularity` - the granularity used to decide if a target is out of date.

### setPreserveLastModified

    public void setPreserveLastModified(boolean preserveLastModified)

  Give the copied files the same last modified time as the original files.

  Parameters:
    `preserveLastModified` - if true preserve the modified time; default is false.

### validateAttributes

    protected void validateAttributes()
                               throws BuildException

  Ensure we have a consistent and legal set of attributes, and set any internal flags necessary based on different combinations of attributes.

  Throws:
    `BuildException` - if an error occurs.

### execute

    public void execute()
                 throws BuildException

  This is a very minimal derivative of the nomal copy logic.

  Overrides:
    `execute` in class `Task`
  Throws:
    `BuildException` - if something goes wrong with the build.

Overview | Package | Class | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD