    001/*
    002 *  Licensed to the Apache Software Foundation (ASF) under one or more
    003 *  contributor license agreements.  See the NOTICE file distributed with
    004 *  this work for additional information regarding copyright ownership.
    005 *  The ASF licenses this file to You under the Apache License, Version 2.0
    006 *  (the "License"); you may not use this file except in compliance with
    007 *  the License.  You may obtain a copy of the License at
    008 *
    009 *      http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 *  Unless required by applicable law or agreed to in writing, software
    012 *  distributed under the License is distributed on an "AS IS" BASIS,
    013 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 *  See the License for the specific language governing permissions and
    015 *  limitations under the License.
    016 */
    017
    018package org.apache.commons.compress.archivers.zip;
    019
    020/**
    021 * The different modes {@link ZipArchiveOutputStream} can operate in.
    022 *
    023 * @see ZipArchiveOutputStream#setUseZip64
    024 *
    025 * @since 1.3
    026 */
    027public enum Zip64Mode {
    028    /**
    029     * Use Zip64 extensions for all entries, even if it is clear it is not required.
    030     */
    031    Always,
    032    /**
    033     * Don't use Zip64 extensions for any entries.
    034     *
    035     * <p>
    036     * This will cause a {@link Zip64RequiredException} to be thrown if {@link ZipArchiveOutputStream} detects it needs Zip64 support.
    037     * </p>
    038     */
    039    Never,
    040    /**
    041     * Use Zip64 extensions for all entries where they are required, don't use them for entries that clearly don't require them.
    042     */
    043    AsNeeded,
    044    /**
    045     * Always use Zip64 extensions for LFH and central directory as {@link Zip64Mode#Always} did, and at the meantime encode the relative offset of LFH and disk
    046     * number start as needed in CFH as {@link Zip64Mode#AsNeeded} did.
    047     * <p>
    048     * This is a compromise for some libraries including 7z and Expand-Archive Powershell utility(and likely Excel).
    049     */
    050    AlwaysWithCompatibility
    051}