View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one or more
3    *  contributor license agreements.  See the NOTICE file distributed with
4    *  this work for additional information regarding copyright ownership.
5    *  The ASF licenses this file to You under the Apache License, Version 2.0
6    *  (the "License"); you may not use this file except in compliance with
7    *  the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   *  Unless required by applicable law or agreed to in writing, software
12   *  distributed under the License is distributed on an "AS IS" BASIS,
13   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   *  See the License for the specific language governing permissions and
15   *  limitations under the License.
16   */
17  
18  package org.apache.commons.compress.archivers.zip;
19  
20  /**
21   * The different modes {@link ZipArchiveOutputStream} can operate in.
22   *
23   * @see ZipArchiveOutputStream#setUseZip64
24   *
25   * @since 1.3
26   */
27  public enum Zip64Mode {
28      /**
29       * Use Zip64 extensions for all entries, even if it is clear it is not required.
30       */
31      Always,
32      /**
33       * Don't use Zip64 extensions for any entries.
34       *
35       * <p>
36       * This will cause a {@link Zip64RequiredException} to be thrown if {@link ZipArchiveOutputStream} detects it needs Zip64 support.
37       * </p>
38       */
39      Never,
40      /**
41       * Use Zip64 extensions for all entries where they are required, don't use them for entries that clearly don't require them.
42       */
43      AsNeeded,
44      /**
45       * 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
46       * number start as needed in CFH as {@link Zip64Mode#AsNeeded} did.
47       * <p>
48       * This is a compromise for some libraries including 7z and Expand-Archive Powershell utility(and likely Excel).
49       */
50      AlwaysWithCompatibility
51  }