LZ4 and xxHash 1.3.0 · net.jpountz.lz4.LZ4Compressor

Access	Constructor and Description
public	LZ4Compressor()

Method Summary

Modifier and Type	Method and Description
public abstract int	Returns: the compressed size compress(byte[] src, int srcOff, int srcLen, byte[] dest, int destOff, int maxDestLen) Compress `src[srcOff:srcOff+srcLen]` into `dest[destOff:destOff+destLen]` and return the compressed length.
public abstract int	Returns: the compressed size compress(ByteBuffer src, int srcOff, int srcLen, ByteBuffer dest, int destOff, int maxDestLen) Compress `src[srcOff:srcOff+srcLen]` into `dest[destOff:destOff+destLen]` and return the compressed length.
public final int	compress(byte[] src, int srcOff, int srcLen, byte[] dest, int destOff) Convenience method, equivalent to calling `compress(src, srcOff, srcLen, dest, destOff, dest.length - destOff)`.
public final int	compress(byte[] src, byte[] dest) Convenience method, equivalent to calling `compress(src, 0, src.length, dest, 0)`.
public final byte[]	compress(byte[] src, int srcOff, int srcLen) Convenience method which returns `src[srcOff:srcOff+srcLen]` compressed.
public final byte[]	compress(byte[] src) Convenience method, equivalent to calling `compress(src, 0, src.length)`.
public final void	compress(ByteBuffer src, ByteBuffer dest) Compress `src` into `dest`.
public final int	maxCompressedLength(int length) Return the maximum compressed length for an input of size `length`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

LZ4Compressor	back to summary
public LZ4Compressor()

Method Detail

compress back to summary

compress	back to summary
public abstract int compress(byte[] src, int srcOff, int srcLen, byte[] dest, int destOff, int maxDestLen) Compress `src[srcOff:srcOff+srcLen]` into `dest[destOff:destOff+destLen]` and return the compressed length. This method will throw a `LZ4Exception` if this compressor is unable to compress the input into less than `maxDestLen` bytes. To prevent this exception to be thrown, you should make sure that `maxDestLen >= maxCompressedLength(srcLen)`. Returns:int the compressed size Exceptions LZ4Exception: if maxDestLen is too small

public abstract int compress(byte[] src, int srcOff, int srcLen, byte[] dest, int destOff, int maxDestLen)

Compress src[srcOff:srcOff+srcLen] into dest[destOff:destOff+destLen] and return the compressed length. This method will throw a LZ4Exception if this compressor is unable to compress the input into less than maxDestLen bytes. To prevent this exception to be thrown, you should make sure that maxDestLen >= maxCompressedLength(srcLen).

Returns:int

the compressed size

Exceptions

LZ4Exception:: if maxDestLen is too small

compress back to summary

compress	back to summary
public abstract int compress(ByteBuffer src, int srcOff, int srcLen, ByteBuffer dest, int destOff, int maxDestLen) Compress `src[srcOff:srcOff+srcLen]` into `dest[destOff:destOff+destLen]` and return the compressed length. This method will throw a `LZ4Exception` if this compressor is unable to compress the input into less than `maxDestLen` bytes. To prevent this exception to be thrown, you should make sure that `maxDestLen >= maxCompressedLength(srcLen)`. `ByteBuffer` positions remain unchanged. Returns:int the compressed size Exceptions LZ4Exception: if maxDestLen is too small

public abstract int compress(ByteBuffer src, int srcOff, int srcLen, ByteBuffer dest, int destOff, int maxDestLen)

Returns:int

the compressed size

Exceptions

LZ4Exception:: if maxDestLen is too small

compress	back to summary
public final int compress(byte[] src, int srcOff, int srcLen, byte[] dest, int destOff) Convenience method, equivalent to calling `compress(src, srcOff, srcLen, dest, destOff, dest.length - destOff)`.

compress	back to summary
public final int compress(byte[] src, byte[] dest) Convenience method, equivalent to calling `compress(src, 0, src.length, dest, 0)`.

compress back to summary

compress	back to summary
public final byte[] compress(byte[] src, int srcOff, int srcLen) Convenience method which returns `src[srcOff:srcOff+srcLen]` compressed. Warning: this method has an important overhead due to the fact that it needs to allocate a buffer to compress into, and then needs to resize this buffer to the actual compressed length. Here is how this method is implemented: final int maxCompressedLength = maxCompressedLength(srcLen); final byte[] compressed = new byte[maxCompressedLength]; final int compressedLength = compress(src, srcOff, srcLen, compressed, 0); return Arrays.copyOf(compressed, compressedLength);

public final byte[] compress(byte[] src, int srcOff, int srcLen)

Convenience method which returns src[srcOff:srcOff+srcLen] compressed.

Warning: this method has an important overhead due to the fact that it needs to allocate a buffer to compress into, and then needs to resize this buffer to the actual compressed length.

Here is how this method is implemented:

final int maxCompressedLength = maxCompressedLength(srcLen);
final byte[] compressed = new byte[maxCompressedLength];
final int compressedLength = compress(src, srcOff, srcLen, compressed, 0);
return Arrays.copyOf(compressed, compressedLength);

compress	back to summary
public final byte[] compress(byte[] src) Convenience method, equivalent to calling `compress(src, 0, src.length)`.

compress	back to summary
public final void compress(ByteBuffer src, ByteBuffer dest) Compress `src` into `dest`. Calling this method will update the positions of both `ByteBuffer`s.

maxCompressedLength back to summary

maxCompressedLength	back to summary
public final int maxCompressedLength(int length) Return the maximum compressed length for an input of size `length`. Annotations @SuppressWarnings:static-method

public final int maxCompressedLength(int length)

Return the maximum compressed length for an input of size length.

Annotations

@SuppressWarnings:static-method

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public abstract Class LZ4Compressor

Constructor Summary

Method Summary

Constructor Detail

Method Detail