001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   https://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.commons.compress.compressors.snappy;
020
021/**
022 * Enumerates dialects of the framing format that {@link FramedSnappyCompressorInputStream} can deal with.
023 *
024 * @since 1.12
025 */
026public enum FramedSnappyDialect {
027
028    /**
029     * The standard as defined by the <a href="https://github.com/google/snappy/blob/master/framing_format.txt">Snappy framing format description</a>
030     */
031    STANDARD(true, true),
032
033    /**
034     * The format used by Apple's iWork Archives (.iwa files).
035     */
036    IWORK_ARCHIVE(false, false);
037
038    private final boolean streamIdentifier;
039
040    private final boolean checksumWithCompressedChunks;
041
042    FramedSnappyDialect(final boolean hasStreamIdentifier, final boolean usesChecksumWithCompressedChunks) {
043        this.streamIdentifier = hasStreamIdentifier;
044        this.checksumWithCompressedChunks = usesChecksumWithCompressedChunks;
045    }
046
047    boolean hasStreamIdentifier() {
048        return streamIdentifier;
049    }
050
051    boolean usesChecksumWithCompressedChunks() {
052        return checksumWithCompressedChunks;
053    }
054}