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 * https://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 * Enumerates dialects of the framing format that {@link FramedSnappyCompressorInputStream} can deal with.
23 *
24 * @since 1.12
25 */
26 public enum FramedSnappyDialect {
27
28 /**
29 * The standard as defined by the <a href="https://github.com/google/snappy/blob/master/framing_format.txt">Snappy framing format description</a>
30 */
31 STANDARD(true, true),
32
33 /**
34 * The format used by Apple's iWork Archives (.iwa files).
35 */
36 IWORK_ARCHIVE(false, false);
37
38 private final boolean streamIdentifier;
39
40 private final boolean checksumWithCompressedChunks;
41
42 FramedSnappyDialect(final boolean hasStreamIdentifier, final boolean usesChecksumWithCompressedChunks) {
43 this.streamIdentifier = hasStreamIdentifier;
44 this.checksumWithCompressedChunks = usesChecksumWithCompressedChunks;
45 }
46
47 boolean hasStreamIdentifier() {
48 return streamIdentifier;
49 }
50
51 boolean usesChecksumWithCompressedChunks() {
52 return checksumWithCompressedChunks;
53 }
54 }