org.jboss.shrinkwrap.api.exporter

Interface ExplodedExporter

All Superinterfaces:

Assignable

public interface ExplodedExporter
extends Assignable

Exporter used to export an Archive as an exploded directory structure.

Version:

$Revision: $

Author:

John Bailey, Aslak Knutsen

Method Summary

Modifier and Type	Method and Description
File	exportExploded(File parentDirectory) Exports provided archive as an exploded directory structure.
File	exportExploded(File parentDirectory, String directoryName) Exports provided archive as an exploded directory structure.
File	exportExplodedInto(File directory) Exports provided archive as an exploded directory structure into the given directory.

Methods inherited from interface org.jboss.shrinkwrap.api.Assignable

as

Method Detail

exportExploded

File exportExploded(File parentDirectory)

Exports provided archive as an exploded directory structure.

Parameters:

parentDirectory - Must be a folder

Returns:

File for exploded archive contents

Throws:

IllegalArgumentException - if the archive or parent directory not valid

ArchiveExportException - if the export process fails

exportExploded

File exportExploded(File parentDirectory,
                    String directoryName)

Exports provided archive as an exploded directory structure.

Parameters:

parentDirectory - Must be a folder

directoryName - The exploded directory name

Returns:

File for exploded archive contents

Throws:

IllegalArgumentException - if the archive or parent directory not valid

ArchiveExportException - if the export process fails

exportExplodedInto

File exportExplodedInto(File directory)

Exports provided archive as an exploded directory structure into the given directory.

Parameters:

directory - Must be a folder

Returns:

File for exploded archive contents

Throws:

IllegalArgumentException - if the archive or parent directory not valid

ArchiveExportException - if the export process fails