View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   * http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.commons.compress.compressors.snappy;
20  
21  /**
22   * Dialects of the framing format that {@link FramedSnappyCompressorInputStream} can deal with.
23   *
24   * @since 1.12
25   */
26  public enum FramedSnappyDialect {
27      /**
28       * The standard as defined by the <a href="https://github.com/google/snappy/blob/master/framing_format.txt">Snappy framing format description</a>
29       */
30      STANDARD(true, true),
31      /**
32       * The format used by Apple's iWork Archives (.iwa files).
33       */
34      IWORK_ARCHIVE(false, false);
35  
36      private final boolean streamIdentifier, checksumWithCompressedChunks;
37  
38      FramedSnappyDialect(final boolean hasStreamIdentifier, final boolean usesChecksumWithCompressedChunks) {
39          this.streamIdentifier = hasStreamIdentifier;
40          this.checksumWithCompressedChunks = usesChecksumWithCompressedChunks;
41      }
42  
43      boolean hasStreamIdentifier() {
44          return streamIdentifier;
45      }
46  
47      boolean usesChecksumWithCompressedChunks() {
48          return checksumWithCompressedChunks;
49      }
50  }