Package org.syncany.chunk

Class GzipTransformer

java.lang.Object

org.syncany.chunk.Transformer

org.syncany.chunk.GzipTransformer

public class GzipTransformer
extends Transformer

Implements a Transformer that transforms the input/output stream using the Gzip compression algorithm.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GzipTransformer.GZIPOutputStreamEx

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	TYPE

Fields inherited from class org.syncany.chunk.Transformer

nextTransformer

Constructor Summary

Constructors

Constructor	Description
GzipTransformer()
GzipTransformer(int level, Transformer nextTransformer)
GzipTransformer(Transformer nextTransformer)

Method Summary

Modifier and Type	Method	Description
java.io.InputStream	createInputStream(java.io.InputStream in)	Creates a strea-transforming InputStream.
java.io.OutputStream	createOutputStream(java.io.OutputStream out)	Create a stream-transforming OutputStream.
void	init(java.util.Map<java.lang.String,java.lang.String> settings)	If a transformer is instantiated via the default constructor (e.g.
java.lang.String	toString()	An implementation of a transformer must override this method to identify the type of transformer and/or its settings.

Methods inherited from class org.syncany.chunk.Transformer

getInstance, setNextTransformer

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

GzipTransformer

public GzipTransformer()

GzipTransformer

public GzipTransformer(Transformer nextTransformer)

GzipTransformer

public GzipTransformer(int level,
                       Transformer nextTransformer)

Method Detail

init

public void init(java.util.Map<java.lang.String,java.lang.String> settings)
          throws java.lang.Exception

Description copied from class: Transformer

If a transformer is instantiated via the default constructor (e.g. via a config file), it must be initialized using this method. The settings passed to the method depend on the implementation of the transformer.

Specified by:

init in class Transformer

Parameters:

settings - Implementation-specific setting map

Throws:

java.lang.Exception - If the given settings are invalid or insufficient for instantiation

createOutputStream

public java.io.OutputStream createOutputStream(java.io.OutputStream out)
                                        throws java.io.IOException

Description copied from class: Transformer

Create a stream-transforming OutputStream. Depending on the implementation, the bytes written to the output stream might be encrypted, compressed, etc.

Specified by:

createOutputStream in class Transformer

Parameters:

out - Original output stream which is transformed by this transformer

Returns:

Returns a transformed output stream

Throws:

java.io.IOException - If an exception occurs when instantiating or writing to the stream

createInputStream

public java.io.InputStream createInputStream(java.io.InputStream in)
                                      throws java.io.IOException

Description copied from class: Transformer

Creates a strea-transforming InputStream. Depending on the implementation, the bytes read from the input stream are uncompressed, decrypted, etc.

Specified by:

createInputStream in class Transformer

Parameters:

in - Original input stream which is transformed by this transformer

Returns:

Returns a transformed input stream

Throws:

java.io.IOException - If an exception occurs when instantiating or reading from the stream

toString

public java.lang.String toString()

Description copied from class: Transformer

An implementation of a transformer must override this method to identify the type of transformer and/or its settings.

Specified by:

toString in class Transformer