Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.tools.ant.taskdefs

Class CopyPath

Implemented Interfaces:
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 String
ERROR_NO_DESTDIR
No destdir attribute
static String
ERROR_NO_MAPPER
No mapper
static 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

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(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, execute, 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, log, log, setDescription, setLocation, setProject

Field Details

ERROR_NO_DESTDIR

public static final String ERROR_NO_DESTDIR
No destdir attribute

ERROR_NO_MAPPER

public static final String ERROR_NO_MAPPER
No mapper

ERROR_NO_PATH

public static final String ERROR_NO_PATH
No path

Method Details

add

public void add(FileNameMapper newmapper)
add a mapper
Parameters:
newmapper - the mapper to add.

createPath

public Path createPath()
Create a path.
Returns:
a path to be configured.

execute

public void execute()
            throws BuildException
This is a very minimal derivative of the nomal copy logic.
Overrides:
execute in interface Task
Throws:
BuildException - if something goes wrong with the build.

setDestDir

public void setDestDir(File destDir)
The dest dir attribute.
Parameters:
destDir - the value of the destdir attribute.

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.

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.

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.

Overview Package Tree Index Deprecated About