Package org.apache.juneau.encoders

Class GzipEncoder

java.lang.Object

org.apache.juneau.encoders.Encoder

org.apache.juneau.encoders.GzipEncoder

public class GzipEncoder
extends Encoder

Encoder for handling "gzip" encoding and decoding.

Notes:

• This class is thread safe and reusable.

See Also:

• Encoders

Constructor Summary

Constructors

Constructor	Description
GzipEncoder()

Method Summary

Modifier and Type	Method	Description
String[]	getCodings()	Returns ["gzip"].
InputStream	getInputStream(InputStream is)	Converts the specified compressed input stream into an uncompressed stream.
OutputStream	getOutputStream(OutputStream os)	Converts the specified uncompressed output stream into an uncompressed stream.

Methods inherited from class java.lang.Object

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

Constructor Details

GzipEncoder

public GzipEncoder()

Method Details

getCodings

public String[] getCodings()

Returns ["gzip"].

Specified by:

getCodings in class Encoder

Returns:

The codings that this encoder handles.

getInputStream

public InputStream getInputStream(InputStream is)
                           throws IOException

Description copied from class: Encoder

Converts the specified compressed input stream into an uncompressed stream.

Specified by:

getInputStream in class Encoder

Parameters:

is - The compressed stream.

Returns:

The uncompressed stream.

Throws:

IOException - If any errors occur, such as on a stream that's not a valid GZIP input stream.

getOutputStream

public OutputStream getOutputStream(OutputStream os)
                             throws IOException

Description copied from class: Encoder

Converts the specified uncompressed output stream into an uncompressed stream.

Specified by:

getOutputStream in class Encoder

Parameters:

os - The uncompressed stream.

Returns:

The compressed stream stream.

Throws:

IOException - If any errors occur.