org.apache.commons.compress.archivers

Interface ArchiveStreamProvider

All Known Implementing Classes:

ArchiveStreamFactory

public interface ArchiveStreamProvider

Creates Archive ArchiveInputStreams and ArchiveOutputStreams.

Since:

1.13

Method Summary

Modifier and Type	Method and Description
<I extends ArchiveInputStream<? extends ArchiveEntry>> I	createArchiveInputStream(String archiverName, InputStream inputStream, String encoding) Creates an archive input stream from an archiver name and an input stream.
<O extends ArchiveOutputStream<? extends ArchiveEntry>> O	createArchiveOutputStream(String archiverName, OutputStream outputStream, String encoding) Creates an archive output stream from an archiver name and an output stream.
Set<String>	getInputStreamArchiveNames() Gets all the input stream archive names for this provider
Set<String>	getOutputStreamArchiveNames() Gets all the output stream archive names for this provider

Method Detail

createArchiveInputStream

<I extends ArchiveInputStream<? extends ArchiveEntry>> I createArchiveInputStream(String archiverName,
                                                                                  InputStream inputStream,
                                                                                  String encoding)
                                                                           throws ArchiveException

Creates an archive input stream from an archiver name and an input stream.

Type Parameters:

I - The ArchiveInputStream type.

Parameters:

archiverName - the archiver name, i.e. "ar", "arj", "zip", "tar", "jar", "cpio", "dump" or "7z"

inputStream - the input stream

encoding - encoding name or null for the default

Returns:

the archive input stream

Throws:

ArchiveException - if the archiver name is not known

StreamingNotSupportedException - if the format cannot be read from a stream

IllegalArgumentException - if the archiver name or stream is null

createArchiveOutputStream

<O extends ArchiveOutputStream<? extends ArchiveEntry>> O createArchiveOutputStream(String archiverName,
                                                                                    OutputStream outputStream,
                                                                                    String encoding)
                                                                             throws ArchiveException

Creates an archive output stream from an archiver name and an output stream.

Type Parameters:

O - The ArchiveInputStream type.

Parameters:

archiverName - the archiver name, i.e. "ar", "zip", "tar", "jar" or "cpio"

outputStream - the output stream

encoding - encoding name or null for the default

Returns:

the archive output stream

Throws:

ArchiveException - if the archiver name is not known

StreamingNotSupportedException - if the format cannot be written to a stream

IllegalArgumentException - if the archiver name or stream is null

getInputStreamArchiveNames

Set<String> getInputStreamArchiveNames()

Gets all the input stream archive names for this provider

Returns:

all the input archive names for this provider

getOutputStreamArchiveNames

Set<String> getOutputStreamArchiveNames()

Gets all the output stream archive names for this provider

Returns:

all the output archive names for this provider