com.partnersoft.io

Class CompressionSwitchingInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.partnersoft.io.CompressionSwitchingInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class CompressionSwitchingInputStream
extends java.io.FilterInputStream

An input stream that turns on and off compression on the fly. Must be mated to a CompressionSwitchingOutputStream that has its compression switched at the right times to match.

Since compression is block-oriented, this is tricky and doesn't support a lot of things (e.g. marking). Also, be aware that just using this and rapidly toggling compression may not actually help, since compression is best done on large amounts of data. Also, compression costs CPU so way the CPU vs. I/O benefit tradeoff, especially for server-side applications.

Copyright 2000-2014 Partner Software, Inc.

Author:

Paul Reavis

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
CompressionSwitchingInputStream(java.io.InputStream in) Create a new CompressionSwitchingInputStream, wrapping the given input.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
boolean	isCompressing() Get whether stream is currently compressing.
int	read()
int	read(byte[] b, int off, int len)
void	setCompressing(boolean tizit) Set whether stream is currently compressing.

Methods inherited from class java.io.FilterInputStream

available, mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

CompressionSwitchingInputStream

public CompressionSwitchingInputStream(java.io.InputStream in)

Create a new CompressionSwitchingInputStream, wrapping the given input.

Parameters:

in - input stream to wrap

Method Detail

read

public int read()
         throws java.io.IOException

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

read

public int read(byte[] b,
       int off,
       int len)
         throws java.io.IOException

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.FilterInputStream

Throws:

java.io.IOException

isCompressing

public boolean isCompressing()

Get whether stream is currently compressing.

Returns:

true if stream is compressing.

setCompressing

public void setCompressing(boolean tizit)
                    throws java.io.IOException

Set whether stream is currently compressing. Does nothing if the stream is already in the specified state.

Parameters:

tizit - whether to turn on compression or turn it off

Throws:

java.io.IOException - if it couldn't make the change