    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 */
    018
    019package org.apache.commons.compress.archivers.zip;
    020
    021/**
    022 * The different modes {@link ZipArchiveOutputStream} can operate in.
    023 *
    024 * @see ZipArchiveOutputStream#setUseZip64
    025 *
    026 * @since 1.3
    027 */
    028public enum Zip64Mode {
    029    /**
    030     * Use Zip64 extensions for all entries, even if it is clear it is
    031     * not required.
    032     */
    033    Always,
    034    /**
    035     * Don't use Zip64 extensions for any entries.
    036     *
    037     * <p>This will cause a {@link Zip64RequiredException} to be
    038     * thrown if {@link ZipArchiveOutputStream} detects it needs Zip64
    039     * support.</p>
    040     */
    041    Never,
    042    /**
    043     * Use Zip64 extensions for all entries where they are required,
    044     * don't use them for entries that clearly don't require them.
    045     */
    046    AsNeeded,
    047    /**
    048     * Always use Zip64 extensions for LFH and central directory as
    049     * {@link Zip64Mode#Always} did, and at the meantime encode
    050     * the relative offset of LFH and disk number start as needed in
    051     * CFH as {@link Zip64Mode#AsNeeded} did.
    052     * <p>
    053     * This is a compromise for some libraries including 7z and
    054     * Expand-Archive Powershell utility(and likely Excel).
    055     */
    056    AlwaysWithCompatibility
    057}