--- /dev/null
+<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
+<!--
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<html>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</head>
+<body>
+<p>LZ4 compression. The entry point of the API is the
+{@link net.jpountz.lz4.LZ4Factory} class, which gives access to
+{@link net.jpountz.lz4.LZ4Compressor compressors} and
+{@link net.jpountz.lz4.LZ4SafeDecompressor decompressors}.</p>
+
+
+<p>Sample usage:</p>
+
+<pre class="prettyprint">
+ LZ4Factory factory = LZ4Factory.fastestInstance();
+
+ byte[] data = "12345345234572".getBytes("UTF-8");
+ final int decompressedLength = data.length;
+
+ // compress data
+ LZ4Compressor compressor = factory.fastCompressor();
+ int maxCompressedLength = compressor.maxCompressedLength(decompressedLength);
+ byte[] compressed = new byte[maxCompressedLength];
+ int compressedLength = compressor.compress(data, 0, decompressedLength, compressed, 0, maxCompressedLength);
+
+ // decompress data
+ // - method 1: when the decompressed length is known
+ LZ4FastDecompressor decompressor = factory.fastDecompressor();
+ byte[] restored = new byte[decompressedLength];
+ int compressedLength2 = decompressor.decompress(compressed, 0, restored, 0, decompressedLength);
+ // compressedLength == compressedLength2
+
+ // - method 2: when the compressed length is known (a little slower)
+ // the destination buffer needs to be over-sized
+ LZ4SafeDecompressor decompressor2 = factory.safeDecompressor();
+ int decompressedLength2 = decompressor2.decompress(compressed, 0, compressedLength, restored, 0);
+ // decompressedLength == decompressedLength2
+</pre>
+
+</body>
+</html>
Code Review / simantics / platform.git / blobdiff