freenet.support.compress

Enum Compressor.COMPRESSOR_TYPE

java.lang.Object

java.lang.Enum<Compressor.COMPRESSOR_TYPE>

freenet.support.compress.Compressor.COMPRESSOR_TYPE

All Implemented Interfaces:

Compressor, java.io.Serializable, java.lang.Comparable<Compressor.COMPRESSOR_TYPE>

Enclosing interface:

Compressor

public static enum Compressor.COMPRESSOR_TYPE
extends java.lang.Enum<Compressor.COMPRESSOR_TYPE>
implements Compressor

Nested Class Summary

Nested classes/interfaces inherited from interface freenet.support.compress.Compressor

Compressor.COMPRESSOR_TYPE

Enum Constant Summary

Enum Constants

Enum Constant and Description
BZIP2
GZIP
LZMA
LZMA_NEW

Field Summary

Fields

Modifier and Type	Field and Description
Compressor	compressor
short	metadataID
java.lang.String	name

Fields inherited from interface freenet.support.compress.Compressor

DEFAULT_COMPRESSORDESCRIPTOR

Method Summary

Modifier and Type	Method and Description
Bucket	compress(Bucket data, BucketFactory bf, long maxReadLength, long maxWriteLength) Compress the data.
long	compress(java.io.InputStream is, java.io.OutputStream os, long maxReadLength, long maxWriteLength) Compress the data.
long	compress(java.io.InputStream is, java.io.OutputStream os, long maxReadLength, long maxWriteLength, long amountOfDataToCheckCompressionRatio, int minimumCompressionPercentage) Compress the data (@see Compressor.compress(InputStream, OutputStream, long, long)) with checking of compression effect.
static int	countCompressors()
int	decompress(byte[] dbuf, int i, int j, byte[] output) Decompress in RAM only.
long	decompress(java.io.InputStream input, java.io.OutputStream output, long maxLength, long maxEstimateSizeLength) Decompress data.
static Compressor.COMPRESSOR_TYPE	getCompressorByMetadataID(short id)
static Compressor.COMPRESSOR_TYPE	getCompressorByName(java.lang.String name)
static java.lang.String	getCompressorDescriptor()
static void	getCompressorDescriptor(java.lang.StringBuilder sb)
static Compressor.COMPRESSOR_TYPE[]	getCompressorsArray(java.lang.String compressordescriptor) make a COMPRESSOR_TYPE[] from a descriptor string the descriptor string is a comma separated list of numbers or names(can be mixed) it is better to store the string in db4o instead of the compressors? if the string is null/empty, it returns COMPRESSOR_TYPE.values() as default
static Compressor.COMPRESSOR_TYPE[]	getCompressorsArrayNoDefault(java.lang.String compressordescriptor)
static java.lang.String	getHelloCompressorDescriptor()
static Compressor.COMPRESSOR_TYPE	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Compressor.COMPRESSOR_TYPE[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GZIP

public static final Compressor.COMPRESSOR_TYPE GZIP

BZIP2

public static final Compressor.COMPRESSOR_TYPE BZIP2

LZMA

public static final Compressor.COMPRESSOR_TYPE LZMA

LZMA_NEW

public static final Compressor.COMPRESSOR_TYPE LZMA_NEW

Field Detail

name

public final java.lang.String name

compressor

public final Compressor compressor

metadataID

public final short metadataID

Method Detail

values

public static Compressor.COMPRESSOR_TYPE[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Compressor.COMPRESSOR_TYPE c : Compressor.COMPRESSOR_TYPE.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Compressor.COMPRESSOR_TYPE valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getCompressorByMetadataID

public static Compressor.COMPRESSOR_TYPE getCompressorByMetadataID(short id)

getCompressorByName

public static Compressor.COMPRESSOR_TYPE getCompressorByName(java.lang.String name)

getHelloCompressorDescriptor

public static java.lang.String getHelloCompressorDescriptor()

getCompressorDescriptor

public static java.lang.String getCompressorDescriptor()

getCompressorDescriptor

public static void getCompressorDescriptor(java.lang.StringBuilder sb)

getCompressorsArray

public static Compressor.COMPRESSOR_TYPE[] getCompressorsArray(java.lang.String compressordescriptor)
                                                        throws InvalidCompressionCodecException

make a COMPRESSOR_TYPE[] from a descriptor string
the descriptor string is a comma separated list of numbers or names(can be mixed)
it is better to store the string in db4o instead of the compressors?
if the string is null/empty, it returns COMPRESSOR_TYPE.values() as default

Parameters:

compressordescriptor -

Returns:

Throws:

InvalidCompressionCodecException

getCompressorsArrayNoDefault

public static Compressor.COMPRESSOR_TYPE[] getCompressorsArrayNoDefault(java.lang.String compressordescriptor)
                                                                 throws InvalidCompressionCodecException

Throws:

InvalidCompressionCodecException

compress

public Bucket compress(Bucket data,
                       BucketFactory bf,
                       long maxReadLength,
                       long maxWriteLength)
                throws java.io.IOException,
                       CompressionOutputSizeException

Description copied from interface: Compressor

Compress the data.

Specified by:

compress in interface Compressor

Parameters:

data - The bucket to read from.

bf - The means to create a new bucket.

maxReadLength - The maximum number of bytes to read from the input bucket.

maxWriteLength - The maximum number of bytes to write to the output bucket. If this is exceeded, throw a CompressionOutputSizeException.

Returns:

The compressed data.

Throws:

java.io.IOException - If an error occurs reading or writing data.

CompressionOutputSizeException - If the compressed data is larger than maxWriteLength.

compress

public long compress(java.io.InputStream is,
                     java.io.OutputStream os,
                     long maxReadLength,
                     long maxWriteLength)
              throws java.io.IOException,
                     CompressionOutputSizeException

Description copied from interface: Compressor

Compress the data.

Specified by:

compress in interface Compressor

Parameters:

is - The InputStream to read from.

os - The OutputStream to write to.

maxReadLength - The maximum number of bytes to read from the input bucket.

maxWriteLength - The maximum number of bytes to write to the output bucket. If this is exceeded, throw a CompressionOutputSizeException.

Returns:

The compressed data.

Throws:

java.io.IOException - If an error occurs reading or writing data.

CompressionOutputSizeException - If the compressed data is larger than maxWriteLength.

compress

public long compress(java.io.InputStream is,
                     java.io.OutputStream os,
                     long maxReadLength,
                     long maxWriteLength,
                     long amountOfDataToCheckCompressionRatio,
                     int minimumCompressionPercentage)
              throws java.io.IOException,
                     CompressionRatioException

Description copied from interface: Compressor

Compress the data (@see Compressor.compress(InputStream, OutputStream, long, long)) with checking of compression effect.

Specified by:

compress in interface Compressor

amountOfDataToCheckCompressionRatio - The data amount after compression of which we will check whether we have got the desired effect.

minimumCompressionPercentage - The minimal desired compression effect, %. A value of 0 means that the compression effect will not be checked.

Throws:

CompressionRatioException - If the desired compression effect is not achieved.

java.io.IOException

decompress

public long decompress(java.io.InputStream input,
                       java.io.OutputStream output,
                       long maxLength,
                       long maxEstimateSizeLength)
                throws java.io.IOException,
                       CompressionOutputSizeException

Description copied from interface: Compressor

Decompress data.

Specified by:

decompress in interface Compressor

Parameters:

input - Where to read the data to decompress from

output - Where to write the final product to

maxLength - The maximum length to decompress (we throw if more is present).

maxEstimateSizeLength - If the data is too big, and this is >0, read up to this many bytes in order to try to get the data size.

Returns:

Number of bytes copied

Throws:

java.io.IOException

CompressionOutputSizeException

decompress

public int decompress(byte[] dbuf,
                      int i,
                      int j,
                      byte[] output)
               throws CompressionOutputSizeException

Description copied from interface: Compressor

Decompress in RAM only.

Specified by:

decompress in interface Compressor

Parameters:

dbuf - Input buffer.

i - Offset to start reading from.

j - Number of bytes to read.

output - Output buffer.

Throws:

CompressionOutputSizeException

countCompressors

public static int countCompressors()