The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Archive::Builder::Archive - Archive abstraction handles

DESCRIPTION

Archive::Builder::Archive objects provide a type neutral handle for outputing the various archive file types Archive::Builder objects.

For more information on Archive::Builder objects, see its POD documentation.

METHODS

types

When loaded, Archive::Builder::Archive examines your system to determine which archive types it is capable of creating, based on dependencies.

The types method returns a list of types that are supported by your system.

new( type, Archive::Builder|Archive::Builder::Section )

Although obtained via the Archive::Builder and Archive::Builder::Section archive methods, archives can be created directly, by passing them a valid type and either an Archive::Builder or Archive::Builder::Section object.

type

Returns the type of an Archive::Builder::Archive object.

generate

Generates and returns the actual archive object, with will be an Archive::Zip, Archive::Tar, or whatever, depending on the type.

Returns undef if an error occurs during file generation, or archive generation.

save( filename )

Generates and saves the archive file to a specific filename. If the file name does NOT end in the file type you have specified, it will be appended for you.

That is, save('file') will result in the creation of file.zip for an archive of type 'zip'.

TODO

More Archive types, like rar.

SUPPORT

Contact the author

AUTHOR

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

SEE ALSO

Archive::Builder, Archive::Builder::Generators, Archive::Tar, Archive::Zip.

COPYRIGHT

Copyright (c) 2002-2004 Adam Kennedy. All rights reserved. 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.