org.jboss.shrinkwrap.api.importer

Interface StreamImporter<I extends StreamImporter<I>>

Type Parameters:

I - Concrete type used in covariant return

All Superinterfaces:

Assignable

All Known Subinterfaces:

TarBz2Importer, TarGzImporter, TarImporter, ZipImporter

All Known Implementing Classes:

TarBz2ImporterImpl, TarGzImporterImpl, TarImporterBase, TarImporterImpl, ZipImporterImpl

public interface StreamImporter<I extends StreamImporter<I>>
extends Assignable

Generic importer capable of representing an Assignable as an entity capable of reading from an InputStream, or file type.

Method Summary

Modifier and Type	Method and Description
I	importFrom(java.io.File file) Imports provided File as a Archive.
I	importFrom(java.io.File file, Filter<ArchivePath> filter) Imports provided File as a Archive.
I	importFrom(java.io.InputStream stream) Imports provided stream as a Archive.
I	importFrom(java.io.InputStream stream, Filter<ArchivePath> filter) Imports provided stream as a Archive.

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

as

Method Detail

importFrom

I importFrom(java.io.InputStream stream)
      throws ArchiveImportException

Imports provided stream as a Archive. It remains the responsibility of the caller to close the stream.

Parameters:

stream - the stream to import; should be a raw type, not wrapped in any implementation-specific encoding (ie. FileInputStream is appropriate, but ZipInputStream or GZIPInputStream is not).

Returns:

Archive of the imported stream

Throws:

ArchiveImportException - If an error occurred during the import process

java.lang.IllegalArgumentException - If no stream is specified

importFrom

I importFrom(java.io.InputStream stream,
             Filter<ArchivePath> filter)
      throws ArchiveImportException

Imports provided stream as a Archive. It remains the responsibility of the caller to close the stream.

Parameters:

stream - the stream to import; should be a raw type, not wrapped in any implementation-specific encoding (ie. FileInputStream is appropriate, but ZipInputStream or GZIPInputStream is not).

filter - Filter to match result

Returns:

Archive of the imported stream

Throws:

ArchiveImportException - If an error occurred during the import process

java.lang.IllegalArgumentException - If no stream is specified

importFrom

I importFrom(java.io.File file)
      throws ArchiveImportException

Imports provided File as a Archive.

Parameters:

file - the file to import

Returns:

Archive of the imported file

Throws:

ArchiveImportException - If an error occurred during the import process

java.lang.IllegalArgumentException - If no file is specified or if the file is a directory

importFrom

I importFrom(java.io.File file,
             Filter<ArchivePath> filter)
      throws ArchiveImportException

Imports provided File as a Archive.

Parameters:

file - the file to import

filter - Filter to match result

Returns:

Archive of the imported file

Throws:

ArchiveImportException - If an error occurred during the import process

java.lang.IllegalArgumentException - If no file is specified or if the file is a directory