org.apache.commons.compress.compressors.snappy.FramedSnappyDialect Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of commons-compress Show documentation

Apache Commons Compress software defines an API for working with compression and archive formats. These include: bzip2, gzip, pack200, lzma, xz, Snappy, traditional Unix Compress, DEFLATE, DEFLATE64, LZ4, Brotli, Zstandard and ar, cpio, jar, tar, zip, dump, 7z, arj.

There is a newer version: 1.26.1

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.commons.compress.compressors.snappy;

/**
 * Dialects of the framing format that {@link FramedSnappyCompressorInputStream} can deal with.
 * @since 1.12
 */
public enum FramedSnappyDialect {
    /**
     * The standard as defined by the Snappy
     * framing format description
     */
    STANDARD(true, true),
    /**
     * The format used by Apple's iWork Archives (.iwa files).
     */
    IWORK_ARCHIVE(false, false);

    private final boolean streamIdentifier, checksumWithCompressedChunks;

    FramedSnappyDialect(final boolean hasStreamIdentifier,
                        final boolean usesChecksumWithCompressedChunks) {
        this.streamIdentifier = hasStreamIdentifier;
        this.checksumWithCompressedChunks = usesChecksumWithCompressedChunks;
    }

    boolean hasStreamIdentifier() {
        return streamIdentifier;
    }

    boolean usesChecksumWithCompressedChunks() {
        return checksumWithCompressedChunks;
    }
}