Package org.jboss.shrinkwrap.impl.base.importer.tar

Class TarImporterBase<S extends TarInputStream,I extends StreamImporter<I>>

java.lang.Object

org.jboss.shrinkwrap.impl.base.AssignableBase<Archive<?>>

org.jboss.shrinkwrap.impl.base.importer.tar.TarImporterBase<S,I>

All Implemented Interfaces:

Assignable, StreamImporter<I>

Direct Known Subclasses:

TarBz2ImporterImpl, TarGzImporterImpl, TarImporterImpl

abstract class TarImporterBase<S extends TarInputStream,I extends StreamImporter<I>>
extends AssignableBase<Archive<?>>
implements StreamImporter<I>

Base of implementations used to import existing TAR files/streams into the given Archive

Field Summary

Fields

Modifier and Type	Field	Description
private static final Logger	log	Logger

Constructor Summary

Constructors

Constructor	Description
TarImporterBase(Archive<?> archive)

Method Summary

Modifier and Type	Method	Description
private I	covarientReturn()	Provides covarient return
(package private) abstract Class<I>	getActualClass()	Returns the actual class for this implementation
private S	getInputStreamForFile(File file)	Obtains an implementation-specific stream to the specified File
(package private) abstract S	getInputStreamForRawStream(InputStream in)	Obtains the correct InputStream wrapper type for the specified raw data input
I	importFrom(File file)	Imports provided File as a Archive.
I	importFrom(File file, Filter<ArchivePath> filter)	Imports provided File as a Archive.
I	importFrom(InputStream stream)	Imports provided stream as a Archive.
I	importFrom(InputStream stream, Filter<ArchivePath> filter)	Imports provided stream as a Archive.
private I	importFrom(S stream, Filter<ArchivePath> filter)

Methods inherited from class org.jboss.shrinkwrap.impl.base.AssignableBase

as, getArchive

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

as

Field Details

log

private static final Logger log

Logger

Constructor Details

TarImporterBase

public TarImporterBase(Archive<?> archive)

Method Details

getActualClass

abstract Class<I> getActualClass()

Returns the actual class for this implementation

getInputStreamForRawStream

abstract S getInputStreamForRawStream(InputStream in)
                               throws IOException

Obtains the correct InputStream wrapper type for the specified raw data input

Parameters:

in -

Returns:

Throws:

IOException

covarientReturn

private I covarientReturn()

Provides covarient return

importFrom

public I importFrom(InputStream stream)
             throws ArchiveImportException

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

Specified by:

importFrom in interface StreamImporter<S extends TarInputStream>

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

See Also:

• StreamImporter.importFrom(java.io.InputStream)

importFrom

public I importFrom(InputStream stream,
 Filter<ArchivePath> filter)
             throws ArchiveImportException

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

Specified by:

importFrom in interface StreamImporter<S extends TarInputStream>

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

See Also:

• StreamImporter.importFrom(java.io.InputStream, Filter)

importFrom

private I importFrom(S stream,
 Filter<ArchivePath> filter)
              throws ArchiveImportException

Throws:

ArchiveImportException

importFrom

public I importFrom(File file)
             throws ArchiveImportException

Imports provided File as a Archive.

Specified by:

importFrom in interface StreamImporter<S extends TarInputStream>

Parameters:

file - the file to import

Returns:

Archive of the imported file

Throws:

ArchiveImportException - If an error occurred during the import process

See Also:

• StreamImporter.importFrom(java.io.File)

importFrom

public I importFrom(File file,
 Filter<ArchivePath> filter)
             throws ArchiveImportException

Imports provided File as a Archive.

Specified by:

importFrom in interface StreamImporter<S extends TarInputStream>

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

See Also:

• StreamImporter.importFrom(java.io.File, Filter)

getInputStreamForFile

private S getInputStreamForFile(File file)
                         throws IOException

Obtains an implementation-specific stream to the specified File

Parameters:

file - To open a stream to, must be specified

Returns:

Throws:

IOException - If there was a problem getting an instream to the file