Return-Path: X-Original-To: apmail-commons-commits-archive@minotaur.apache.org Delivered-To: apmail-commons-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id CA8EC110A3 for ; Sat, 12 Jul 2014 05:46:33 +0000 (UTC) Received: (qmail 24691 invoked by uid 500); 12 Jul 2014 05:46:32 -0000 Delivered-To: apmail-commons-commits-archive@commons.apache.org Received: (qmail 24617 invoked by uid 500); 12 Jul 2014 05:46:32 -0000 Mailing-List: contact commits-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@commons.apache.org Delivered-To: mailing list commits@commons.apache.org Received: (qmail 24607 invoked by uid 99); 12 Jul 2014 05:46:32 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 12 Jul 2014 05:46:32 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 12 Jul 2014 05:46:30 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 5A59B2388868; Sat, 12 Jul 2014 05:46:10 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1609881 - in /commons/proper/compress/trunk/src: main/java/org/apache/commons/compress/compressors/deflate/package.html site/xdoc/examples.xml site/xdoc/index.xml site/xdoc/limitations.xml Date: Sat, 12 Jul 2014 05:46:10 -0000 To: commits@commons.apache.org From: bodewig@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20140712054610.5A59B2388868@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: bodewig Date: Sat Jul 12 05:46:09 2014 New Revision: 1609881 URL: http://svn.apache.org/r1609881 Log: COMPRESS-263 add boilerplate docs for DEFLATE Added: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/deflate/package.html - copied, changed from r1609880, commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/lzma/package.html Modified: commons/proper/compress/trunk/src/site/xdoc/examples.xml commons/proper/compress/trunk/src/site/xdoc/index.xml commons/proper/compress/trunk/src/site/xdoc/limitations.xml Copied: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/deflate/package.html (from r1609880, commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/lzma/package.html) URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/deflate/package.html?p2=commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/deflate/package.html&p1=commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/lzma/package.html&r1=1609880&r2=1609881&rev=1609881&view=diff ============================================================================== --- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/lzma/package.html (original) +++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/deflate/package.html Sat Jul 12 05:46:09 2014 @@ -18,16 +18,7 @@ --> -

Provides a stream class decompressing streams using the - "stand-alone" LZMA algorithm.

- -

The class in this package is a wrapper around {@link - org.tukaani.xz.LZMAInputStream org.tukaani.xz.LZMAInputStream} - and provided by the public - domain XZ for Java - library.

- -

In general you should prefer the more modern and robust XZ - format over stand-alone LZMA compression.

Provides a stream classes that allow (de)compressing streams + using the DEFLATE algorithm.

Modified: commons/proper/compress/trunk/src/site/xdoc/examples.xml URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/site/xdoc/examples.xml?rev=1609881&r1=1609880&r2=1609881&view=diff ============================================================================== --- commons/proper/compress/trunk/src/site/xdoc/examples.xml (original) +++ commons/proper/compress/trunk/src/site/xdoc/examples.xml Sat Jul 12 05:46:09 2014 @@ -32,9 +32,9 @@ compressed) archive are archiver formats.

The compressor formats supported are gzip, bzip2, xz, lzma, - Pack200a and Z, the archiver formats are 7z, ar, arj, cpio, dump, - tar and zip. Pack200 is a special case as it can only - compress JAR files.

+ Pack200, DEFLATE and Z, the archiver formats are 7z, ar, arj, + cpio, dump, tar and zip. Pack200 is a special case as it can + only compress JAR files.

We currently only provide read support for lzma, arj, dump and Z. arj can only read uncompressed archives, 7z can read @@ -481,6 +481,26 @@ lzmaIn.close(); ]]> + + +

Uncompressing a given DEFLATE compressed file (you would + certainly add exception handling and make sure all streams + get closed properly):

+ + +

Note that Commons Compress currently only supports Modified: commons/proper/compress/trunk/src/site/xdoc/index.xml URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/site/xdoc/index.xml?rev=1609881&r1=1609880&r2=1609881&view=diff ============================================================================== --- commons/proper/compress/trunk/src/site/xdoc/index.xml (original) +++ commons/proper/compress/trunk/src/site/xdoc/index.xml Sat Jul 12 05:46:09 2014 @@ -27,7 +27,7 @@

The Apache Commons Compress library defines an API for working with ar, cpio, Unix dump, tar, zip, gzip, XZ, Pack200, - bzip2, 7z, arj, lzma, snappy and Z files. + bzip2, 7z, arj, lzma, snappy, DEFLATE and Z files.

The code in this component has many origins: @@ -64,8 +64,11 @@ CompressorStreamFactory can now autodetect the .Z compress format.

- + +

support for raw DEFLATE streams

Modified: commons/proper/compress/trunk/src/site/xdoc/limitations.xml URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/site/xdoc/limitations.xml?rev=1609881&r1=1609880&r2=1609881&view=diff ============================================================================== --- commons/proper/compress/trunk/src/site/xdoc/limitations.xml (original) +++ commons/proper/compress/trunk/src/site/xdoc/limitations.xml Sat Jul 12 05:46:09 2014 @@ -77,6 +77,12 @@

We are not aware of any problems.

CompressorStreamFactory is not able to auto-detect + streams using DEFLATE compression.

read-only support