/ 
File-Tasks-0.07
River stage zero No dependents
/ File::Tasks::Remove

NAME

File::Tasks::Remove - A File::Tasks delete task (deletes a file)

DESCRIPTION

The File::Tasks::Delete task provides a mechanism for the File::Tasks to know about existing files, and instruct that they are no longer needed.

METHODS

new $Tasks, $path, $source

Creates a new File::Tasks::Edit object, although you probably won't be creating this object directly from here.

Returns a new File::Tasks::Edit object, or undef on error.

type

Returns the task type, which is always 'Remove'.

path

The path accessor returns the path to the file within the set of tasks.

source

The source accessor returns the content source, which could be anything supported by File::Tasks::Provider.

test

The test methods checks to see that the file on the filesystem exists, and that it can be removed.

Returns true if so, or false if not.

execute

The execute method executes the task, removing the existing file.

Returns true on success or undef on error.

SUPPORT

Bugs should be reported via the CPAN bug tracker at

http://rt.cpan.org/NoAuth/ReportBug.html?Queue=File-Tasks

For other issues, contact the author.

AUTHOR

Adam Kennedy <adamk@cpan.org>, http://ali.as/

COPYRIGHT

Copyright 2005 Adam Kennedy.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.