Copy Apache Ant 1.7.1)

Methods

Hide/Show inherited methods

public void add (FileNameMapper fileNameMapper)

Add a nested filenamemapper.

public void add (ResourceCollection res)

Add a collection of files to copy.

public void addFileset (FileSet set)

Add a set of files to copy.

publicfinal void bindToOwner (Task owner) [Inherited From Task]

Bind a task to another; use this when configuring a newly created task to do work on behalf of another.

protected void buildMap (java.io.File fromDir, java.io.File toDir, java.lang.String names, FileNameMapper mapper, java.util.Hashtable map)

Add to a map of files/directories to copy.

Add to a map of files/directories to copy.
Parameters:
- fromDir - the source directory.
- toDir - the destination directory.
- names - a list of filenames.
- mapper - a FileNameMapper value.
- map - a map of source file to array of destination files.

protected java.util.Map buildMap (Resource fromResources, java.io.File toDir, FileNameMapper mapper)

Create a map of resources to copy.

Create a map of resources to copy.
Returns: a map of source resource to array of destination files.
Parameters:
- fromResources - The source resources.
- toDir - the destination directory.
- mapper - a FileNameMapper value.
Since: Ant 1.7

public java.lang.Object clone () throws java.lang.CloneNotSupportedException [Inherited From ProjectComponent]

public FilterChain createFilterChain ()

Add a FilterChain.

public FilterSet createFilterSet ()

Add a filterset.

public Mapper createMapper () throws BuildException

Define the mapper to map source to destination files.

protected void doFileOperations ()

Actually does the file (and possibly empty directory) copies.

protected void doResourceOperations (java.util.Map map)

Actually does the resource copies.

public void execute () throws BuildException [Overrides Task]

Perform the copy operation.

public java.lang.String getDescription () [Inherited From ProjectComponent]

Returns the description of the current action.

Returns the description of the current action.
Returns: the description of the current action, or null if no description is available.

public java.lang.String getEncoding ()

Get the character encoding to be used.

Get the character encoding to be used.
Returns: the character encoding, null if not set.
Since: 1.32, Ant 1.5

protected FileUtils getFileUtils ()

Get the FileUtils for this task.

protected java.util.Vector getFilterChains ()

Get the filterchains being applied to this operation.

protected java.util.Vector getFilterSets ()

Get the filtersets being applied to this operation.

public Location getLocation () [Inherited From ProjectComponent]

Returns the file/location where this task was defined.

Returns the file/location where this task was defined.
Returns: the file/location where this task was defined. Should not return null. Location.UNKNOWN_LOCATION is used for unknown locations.
See Also: Location.UNKNOWN_LOCATION,

public java.lang.String getOutputEncoding ()

Get the character encoding for output files.

Get the character encoding for output files.
Returns: the character encoding for output files, null if not set.
Since: Ant 1.6

public Target getOwningTarget () [Inherited From Task]

Returns the container target of this task.

Returns the container target of this task.
Returns: The target containing this task, or null if this task is a top-level task.

public boolean getPreserveLastModified ()

Get whether to give the copied files the same last modified time as the original files.

public Project getProject () [Inherited From ProjectComponent]

Returns the project to which this component belongs.

public RuntimeConfigurable getRuntimeConfigurableWrapper () [Inherited From Task]

Returns the wrapper used for runtime configuration.

public java.lang.String getTaskName () [Inherited From Task]

Returns the name to use in logging messages.

public java.lang.String getTaskType () [Inherited From Task]

Return the type of task.

protected RuntimeConfigurable getWrapper () [Inherited From Task]

Return the runtime configurable structure for this task.

protected void handleErrorFlush (java.lang.String output) [Inherited From Task]

Handles an error line by logging it with the WARN priority.

Handles an error line by logging it with the WARN priority.
Parameters:
- output - The error output to log. Should not be null.
Since: Ant 1.5.2

protected void handleErrorOutput (java.lang.String output) [Inherited From Task]

Handles an error output by logging it with the WARN priority.

Handles an error output by logging it with the WARN priority.
Parameters:
- output - The error output to log. Should not be null.

protected void handleFlush (java.lang.String output) [Inherited From Task]

Handles output by logging it with the INFO priority.

Handles output by logging it with the INFO priority.
Parameters:
- output - The output to log. Should not be null.
Since: Ant 1.5.2

protected int handleInput (byte[] buffer, int offset, int length) throws java.io.IOException [Inherited From Task]

Handle an input request by this task.

protected void handleOutput (java.lang.String output) [Inherited From Task]

Handles output by logging it with the INFO priority.

Handles output by logging it with the INFO priority.
Parameters:
- output - The output to log. Should not be null.

public void init () throws BuildException [Inherited From Task]

Called by the project to let the task initialize properly.

public boolean isEnableMultipleMapping ()

Get whether multiple mapping is enabled.

protectedfinal boolean isInvalid () [Inherited From Task]

Has this task been marked invalid?

public void log (java.lang.String msg) [Inherited From Task]

Logs a message with the default (INFO) priority.

Logs a message with the default (INFO) priority.
Parameters:
- msg - The message to be logged. Should not be null.

public void log (java.lang.String msg, int msgLevel) [Inherited From Task]

Logs a message with the given priority.

Logs a message with the given priority. This delegates
the actual logging to the project.
Parameters:
- msg - The message to be logged. Should not be null.
- msgLevel - The message priority at which this message is to be logged.

public void log (java.lang.String msg, java.lang.Throwable t, int msgLevel) [Inherited From Task]

Logs a message with the given priority.

Logs a message with the given priority. This delegates
the actual logging to the project.
Parameters:
- msg - The message to be logged. Should not be null.
- t - The exception to be logged. May be null.
- msgLevel - The message priority at which this message is to be logged.
Since: 1.7

public void log (java.lang.Throwable t, int msgLevel) [Inherited From Task]

Logs a message with the given priority.

Logs a message with the given priority. This delegates
the actual logging to the project.
Parameters:
- t - The exception to be logged. Should not be null.
- msgLevel - The message priority at which this message is to be logged.
Since: 1.7

public void maybeConfigure () throws BuildException [Inherited From Task]

Configures this task - if it hasn't been done already.

publicfinal void perform () [Inherited From Task]

Performs this task if it's still valid, or gets a replacement version and performs that otherwise.

public void reconfigure () [Inherited From Task]

Force the task to be reconfigured from its RuntimeConfigurable.

protected void scan (java.io.File fromDir, java.io.File toDir, java.lang.String files, java.lang.String dirs)

Compares source files to destination files to see if they should be copied.

protected java.util.Map scan (Resource fromResources, java.io.File toDir)

Compares source resources to destination files to see if they should be copied.

public void setDescription (java.lang.String desc) [Inherited From ProjectComponent]

Sets a description of the current action.

Sets a description of the current action. This may be used for logging
purposes.
Parameters:
- desc - Description of the current action. May be null, indicating that no description is available.

public void setEnableMultipleMappings (boolean enableMultipleMappings)

Set method of handling mappers that return multiple mappings for a given source path.

public void setEncoding (java.lang.String encoding)

Set the character encoding.

public void setFailOnError (boolean failonerror)

Set whether to fail when errors are encountered.

public void setFile (java.io.File file)

Set a single source file to copy.

public void setFiltering (boolean filtering)

Set filtering mode.

public void setFlatten (boolean flatten)

Set whether files copied from directory trees will be "flattened" into a single directory.

public void setGranularity (long granularity)

Set the number of milliseconds leeway to give before deciding a target is out of date.

public void setIncludeEmptyDirs (boolean includeEmpty)

Set whether to copy empty directories.

public void setLocation (Location location) [Inherited From ProjectComponent]

Sets the file/location where this task was defined.

Sets the file/location where this task was defined.
Parameters:
- location - The file/location where this task was defined. Should not be null--use Location.UNKNOWN_LOCATION if the location isn't known.
See Also: Location.UNKNOWN_LOCATION,

public void setOutputEncoding (java.lang.String encoding)

Set the character encoding for output files.

public void setOverwrite (boolean overwrite)

Set overwrite mode regarding existing destination file(s).

public void setOwningTarget (Target target) [Inherited From Task]

Sets the target container of this task.

Sets the target container of this task.
Parameters:
- target - Target in whose scope this task belongs. May be null, indicating a top-level task.

public void setPreserveLastModified (boolean preserve)

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

public void ~~setPreserveLastModified~~ (java.lang.String preserve)

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

public void setProject (Project project) [Inherited From ProjectComponent]

Sets the project object of this component.

Sets the project object of this component. This method is used by
Project when a component is added to it so that the component has
access to the functions of the project. It should not be used
for any other purpose.
Parameters:
- project - Project in whose scope this component belongs. Must not be null.

public void setRuntimeConfigurableWrapper (RuntimeConfigurable wrapper) [Inherited From Task]

Sets the wrapper to be used for runtime configuration.

Sets the wrapper to be used for runtime configuration.

This method should be used only by the ProjectHelper and Ant internals.
It is public to allow helper plugins to operate on tasks, normal tasks
should never use it.
Parameters:
- wrapper - The wrapper to be used for runtime configuration. May be null, in which case the next call to getRuntimeConfigurableWrapper will generate a new wrapper.

public void setTaskName (java.lang.String name) [Inherited From Task]

Sets the name to use in logging messages.

Sets the name to use in logging messages.
Parameters:
- name - The name to use in logging messages. Should not be null.

public void setTaskType (java.lang.String type) [Inherited From Task]

Sets the name with which the task has been invoked.

Sets the name with which the task has been invoked.
Parameters:
- type - The name the task has been invoked as. Should not be null.

public void setTodir (java.io.File destDir)

Set the destination directory.

public void setTofile (java.io.File destFile)

Set the destination file.

public void setVerbose (boolean verbose)

Set verbose mode.

protected boolean supportsNonFileResources ()

Whether this task can deal with non-file resources.

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.