Package org.apache.hop.core.compress.zip

Class ZipCompressionProvider

java.lang.Object

org.apache.hop.core.compress.zip.ZipCompressionProvider

All Implemented Interfaces:

ICompressionProvider

@CompressionPlugin(id="Zip",
                   name="Zip",
                   description="ZIP compression")
public class ZipCompressionProvider
extends Object
implements ICompressionProvider

Constructor Summary

Constructors

Constructor	Description
ZipCompressionProvider()

Method Summary

Modifier and Type	Method	Description
ZipCompressionInputStream	createInputStream(InputStream in)	Creates an input stream that decompresses data (according to the provider's implementation)
ZipCompressionOutputStream	createOutputStream(OutputStream out)	Creates an output stream that compresses data (according to the provider's implementation)
String	getDefaultExtension()	Gets the default file extension for this provider.
String	getDescription()	Gets the name of this provider.
String	getName()	Gets the name of this provider.
boolean	supportsInput()	Whether this compression provider supports input streams
boolean	supportsOutput()	Whether this compression provider supports output streams

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipCompressionProvider

public ZipCompressionProvider()

Method Detail

createInputStream

public ZipCompressionInputStream createInputStream(InputStream in)
                                            throws IOException

Description copied from interface: ICompressionProvider

Creates an input stream that decompresses data (according to the provider's implementation)

Specified by:

createInputStream in interface ICompressionProvider

Parameters:

in - An existing input stream to wrap

Returns:

a CompressionInputStream object that decompresses incoming data

Throws:

IOException

supportsInput

public boolean supportsInput()

Description copied from interface: ICompressionProvider

Whether this compression provider supports input streams

Specified by:

supportsInput in interface ICompressionProvider

Returns:

true if the provider supports input streams, false otherwise

createOutputStream

public ZipCompressionOutputStream createOutputStream(OutputStream out)
                                              throws IOException

Description copied from interface: ICompressionProvider

Creates an output stream that compresses data (according to the provider's implementation)

Specified by:

createOutputStream in interface ICompressionProvider

Parameters:

out - An existing output stream to wrap

Returns:

a CompressionOutputStream object that compresses outgoing data

Throws:

IOException

supportsOutput

public boolean supportsOutput()

Description copied from interface: ICompressionProvider

Whether this compression provider supports output streams

Specified by:

supportsOutput in interface ICompressionProvider

Returns:

true if the provider supports output streams, false otherwise

getDescription

public String getDescription()

Description copied from interface: ICompressionProvider

Gets the name of this provider. Used for display e.g.

Specified by:

getDescription in interface ICompressionProvider

Returns:

A String containing a description of this provider

getName

public String getName()

Description copied from interface: ICompressionProvider

Gets the name of this provider. Used for display and as a reference in saved artifacts (pipelines, e.g.)

Specified by:

getName in interface ICompressionProvider

Returns:

A String containing the name of this provider

getDefaultExtension

public String getDefaultExtension()

Description copied from interface: ICompressionProvider

Gets the default file extension for this provider. If the streams are wrapped in File streams, this method can be used to determine an appropriate extension to append to the filename so the file will be recognized as an artifact of the compression mechanism (.zip, .bz2, e.g.)

Specified by:

getDefaultExtension in interface ICompressionProvider

Returns:

A String containing the default file extension for this provider