| Stefan Bodewig | 5fb7664 | 2013-12-01 07:19:32 +0000 | [diff] [blame] | 1 | <html> |
| 2 | <!-- |
| 3 | |
| 4 | Licensed to the Apache Software Foundation (ASF) under one or more |
| 5 | contributor license agreements. See the NOTICE file distributed with |
| 6 | this work for additional information regarding copyright ownership. |
| 7 | The ASF licenses this file to You under the Apache License, Version 2.0 |
| 8 | (the "License"); you may not use this file except in compliance with |
| 9 | the License. You may obtain a copy of the License at |
| 10 | |
| 11 | http://www.apache.org/licenses/LICENSE-2.0 |
| 12 | |
| 13 | Unless required by applicable law or agreed to in writing, software |
| 14 | distributed under the License is distributed on an "AS IS" BASIS, |
| 15 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 16 | See the License for the specific language governing permissions and |
| 17 | limitations under the License. |
| 18 | |
| 19 | --> |
| 20 | <body> |
| Stefan Bodewig | d0663f7 | 2017-01-16 06:20:39 +0100 | [diff] [blame] | 21 | <p>Provides stream classes for the |
| Stefan Bodewig | 0e831a1 | 2017-01-09 08:24:58 +0100 | [diff] [blame] | 22 | <a href="https://github.com/google/snappy">Snappy</a> |
| Stefan Bodewig | 5fb7664 | 2013-12-01 07:19:32 +0000 | [diff] [blame] | 23 | algorithm.</p> |
| 24 | |
| 25 | <p>The raw Snappy format which only contains the compressed data |
| Stefan Bodewig | d0663f7 | 2017-01-16 06:20:39 +0100 | [diff] [blame] | 26 | is supported by the <code>SnappyCompressor*putStream</code> |
| 27 | classes while the so called "framing format" is implemented |
| 28 | by <code>FramedSnappyCompressor*putStream</code>. Note there |
| 29 | have been different versions of the framing format specification, |
| Stefan Bodewig | 5fb7664 | 2013-12-01 07:19:32 +0000 | [diff] [blame] | 30 | the implementation in Commons Compress is based on the |
| 31 | specification "Last revised: 2013-10-25".</p> |
| 32 | |
| 33 | <p>Only the "framing format" can be auto-detected this means you |
| 34 | have to speficy the format explicitly if you want to read a |
| 35 | "raw" Snappy stream |
| 36 | via <code>CompressorStreamFactory</code>.</p> |
| 37 | </body> |
| 38 | </html> |