Interface StreamExporter
- All Superinterfaces:
Assignable
- All Known Subinterfaces:
TarBz2Exporter
,TarExporter
,TarGzExporter
,ZipExporter
- All Known Implementing Classes:
AbstractStreamExporterImpl
,TarBz2ExporterImpl
,TarExporterImpl
,TarGzExporterImpl
,ZipExporterImpl
Generic exporter capable of representing an
Assignable
as an InputStream
, or writing its contents to
a provided OutputStream
or File
.- Version:
- $Revision: $
-
Method Summary
Modifier and TypeMethodDescriptionExports this reference in an implementation-specific format represented by the returned newInputStream
instancevoid
Exports provided archive as in an implementation-specific format, written to the specifiedFile
target.void
Exports provided archive an implementation-specific format, written to the specifiedFile
target.void
exportTo
(OutputStream target) Exports provided archive in an implementation-specific format, written to the specifiedOutputStream
target.Methods inherited from interface org.jboss.shrinkwrap.api.Assignable
as
-
Method Details
-
exportAsInputStream
InputStream exportAsInputStream()Exports this reference in an implementation-specific format represented by the returned newInputStream
instance- Returns:
- A new
InputStream
to read the exported view
-
exportTo
Exports provided archive in an implementation-specific format, written to the specifiedOutputStream
target. The specified target will not be closed or flushed; this is the responsibility of the caller (who supplied theOutputStream
in the first place).- Parameters:
target
-- Throws:
ArchiveExportException
IllegalArgumentException
- If the target is not specified or is closed
-
exportTo
Exports provided archive as in an implementation-specific format, written to the specifiedFile
target. If the target exists this call will fail withIllegalArgumentException
- Parameters:
target
-- Throws:
IllegalArgumentException
- If the target is not specifiedFileExistsException
- If the target already existsArchiveExportException
- if the export process fails
-
exportTo
Exports provided archive an implementation-specific format, written to the specifiedFile
target. If the target both exists and the "overwrite" flag is true, this call will allow the existing file to be overwritten, else the invocation will fail withIllegalArgumentException
- Parameters:
target
-- Throws:
IllegalArgumentException
- If the target is not specified or is a directoryFileExistsException
- If the target both already exists and the overwrite flag is falseArchiveExportException
- if the export process fails
-