ZipFileHeader.Builder (Simple Zip 2.2 API)

java.lang.Object
- com.j256.simplezip.format.ZipFileHeader.Builder

Enclosing class:: ZipFileHeader

public static class ZipFileHeader.Builder
extends Object

Builder for ZipFileHeader.

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ZipFileHeader.Builder`	`addExtraField(BaseExtraField extraField)` Add an extra field to the header other than the `setZip64ExtraField(Zip64ExtraField)`.
`void`	`addGeneralPurposeFlag(GeneralPurposeFlag generalPurposeFlag)` Add a general-purpose-flag as an enum.
`void`	`addGeneralPurposeFlags(Collection<GeneralPurposeFlag> generalPurposeFlagSet)` Sets the general-purpose-flags as a set of enums.
`void`	`addGeneralPurposeFlags(GeneralPurposeFlag... generalPurposeFlagEnums)` Sets the general-purpose-flags as an array of enums.
`void`	`assignGeneralPurposeFlag(GeneralPurposeFlag flag, boolean value)` Assign a flag via turning on and off.
`ZipFileHeader`	`build()` Build an instance of the file-header.
`void`	`clearGeneralPurposeFlag(GeneralPurposeFlag generalPurposeFlag)` Clear a general-purpose-flag as an enum.
`static ZipFileHeader.Builder`	`fromFile(File file)` Initialize a builder with the last-modified date/time and file-name from a disk file.
`static ZipFileHeader.Builder`	`fromHeader(ZipFileHeader header)` Start a builder from a previous Zip file-header.
`long`	`getCompressedSize()`
`int`	`getCompressionMethod()`
`CompressionMethod`	`getCompressionMethodAsEnum()`
`long`	`getCrc32()`
`byte[]`	`getExtraFieldBytes()`
`String`	`getFileName()`
`byte[]`	`getFileNameBytes()`
`Set<GeneralPurposeFlag>`	`getGeneralPurposeFlagAsEnums()` Return the set of GeneralPurposeFlag enums that make up the general-purpose-flags.
`int`	`getGeneralPurposeFlags()`
`int`	`getLastModifiedDate()` Last modified date in the MS-DOS date format.
`int`	`getLastModifiedTime()` Last modified time in the MS-DOS time format.
`long`	`getUncompressedSize()`
`int`	`getVersionNeeded()`
`Zip64ExtraField`	`getZip64ExtraField()`
`void`	`reset()` Clear all fields in the builder.
`void`	`setCompressedSize(long compressedSize)` Set to the compressed (encoded) size of the bytes.
`void`	`setCompressionMethod(CompressionMethod method)`
`void`	`setCompressionMethod(int compressionMethod)`
`void`	`setCrc32(long crc32)` Set to the crc checksum of the uncompressed bytes.
`void`	`setCrc32Value(CRC32 crc32)`
`void`	`setExtraFieldBytes(byte[] extraFieldBytes)` Set the extra-field-bytes.
`void`	`setFileName(String fileName)`
`void`	`setFileNameBytes(byte[] fileName)`
`void`	`setGeneralPurposeFlags(int generalPurposeFlags)` Sets the general-purpose-flags as a integer value.
`void`	`setLastModifiedDate(int lastModifiedDate)` Last modified date in the MS-DOS date format.
`void`	`setLastModifiedDateTime(File file)` Set the lastModFileDate and lastModFileTime from epoch milliseconds last-modified value from the File.
`void`	`setLastModifiedDateTime(java.time.LocalDateTime lastModifiedDateTime)` Set the lastModFileDate and lastModFileTime as a `LocalDateTime`.
`void`	`setLastModifiedDateTime(long dateTimeMillis)` Set the lastModFileDate and lastModFileTime as an epoch milliseconds.
`void`	`setLastModifiedTime(int lastModifiedTime)` Last modified time in the MS-DOS time format.
`void`	`setUncompressedSize(long uncompressedSize)` Set to the uncompressed (unencoded) size of the bytes.
`void`	`setVersionNeeded(int versionNeeded)`
`void`	`setVersionNeededMajorMinor(int major, int minor)`
`void`	`setZip64ExtraField(Zip64ExtraField zip64ExtraField)`
`ZipFileHeader.Builder`	`withCompressedSize(long compressedSize)` Set to the compressed (encoded) size of the bytes.
`ZipFileHeader.Builder`	`withCompressionMethod(CompressionMethod method)`
`ZipFileHeader.Builder`	`withCompressionMethod(int compressionMethod)`
`ZipFileHeader.Builder`	`withCrc32(long crc32)`
`ZipFileHeader.Builder`	`withExtraFieldBytes(byte[] extraFieldBytes)` Set the extra-field-bytes.
`ZipFileHeader.Builder`	`withFileName(String fileName)`
`ZipFileHeader.Builder`	`withFileNameBytes(byte[] fileName)`
`ZipFileHeader.Builder`	`withGeneralPurposeFlag(GeneralPurposeFlag generalPurposeFlag)` Sets the general-purpose-flag as a an enums.
`ZipFileHeader.Builder`	`withGeneralPurposeFlags(Collection<GeneralPurposeFlag> generalPurposeFlagSet)` Sets the general-purpose-flags as a set of enums.
`ZipFileHeader.Builder`	`withGeneralPurposeFlags(GeneralPurposeFlag... generalPurposeFlagEnums)` Sets the general-purpose-flags as an array of enums.
`ZipFileHeader.Builder`	`withGeneralPurposeFlags(int generalPurposeFlags)` Sets the general-purpose-flags as a integer value.
`ZipFileHeader.Builder`	`withLastModifiedDate(int lastModifiedDate)` Last modified date in the MS-DOS date format.
`ZipFileHeader.Builder`	`withLastModifiedDateTime(File file)` Set the lastModFileDate and lastModFileTime from epoch milliseconds last-modified value from the File.
`ZipFileHeader.Builder`	`withLastModifiedDateTime(java.time.LocalDateTime lastModifiedDateTime)` Set the lastModFileDate and lastModFileTime as a `LocalDateTime`.
`ZipFileHeader.Builder`	`withLastModifiedDateTime(long dateTimeMillis)` Set the lastModFileDate and lastModFileTime as an epoch milliseconds.
`ZipFileHeader.Builder`	`withLastModifiedTime(int lastModifiedTime)` Last modified time in the MS-DOS time format.
`ZipFileHeader.Builder`	`withUncompressedSize(long uncompressedSize)` Set to the uncompressed (unencoded) size of the bytes.
`ZipFileHeader.Builder`	`withVersionNeeded(int versionNeeded)`
`ZipFileHeader.Builder`	`withVersionNeededMajorMinor(int major, int minor)`
`ZipFileHeader.Builder`	`withZip64ExtraField(Zip64ExtraField zip64ExtraField)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - build
```
public ZipFileHeader build()
```
    Build an instance of the file-header.
  - fromHeader
```
public static ZipFileHeader.Builder fromHeader(ZipFileHeader header)
```
    Start a builder from a previous Zip file-header.
  - fromFile
```
public static ZipFileHeader.Builder fromFile(File file)
```
    Initialize a builder with the last-modified date/time and file-name from a disk file. It uses the File.getPath() as the file-name.
  - reset
```
public void reset()
```
    Clear all fields in the builder. This does set a couple of default fields.
  - getVersionNeeded
```
public int getVersionNeeded()
```
  - setVersionNeeded
```
public void setVersionNeeded(int versionNeeded)
```
  - withVersionNeeded
```
public ZipFileHeader.Builder withVersionNeeded(int versionNeeded)
```
  - setVersionNeededMajorMinor
```
public void setVersionNeededMajorMinor(int major,
                                       int minor)
```
  - withVersionNeededMajorMinor
```
public ZipFileHeader.Builder withVersionNeededMajorMinor(int major,
                                                         int minor)
```
  - getGeneralPurposeFlags
```
public int getGeneralPurposeFlags()
```
  - setGeneralPurposeFlags
```
public void setGeneralPurposeFlags(int generalPurposeFlags)
```
    Sets the general-purpose-flags as a integer value. This overrides the value set by the add and with flag(s).
  - withGeneralPurposeFlags
```
public ZipFileHeader.Builder withGeneralPurposeFlags(int generalPurposeFlags)
```
    Sets the general-purpose-flags as a integer value. This overrides the value set by the add and with flag(s).
  - assignGeneralPurposeFlag
```
public void assignGeneralPurposeFlag(GeneralPurposeFlag flag,
                                     boolean value)
```
    Assign a flag via turning on and off. This updates the value set by setGeneralPurposeFlags(int).
  - getGeneralPurposeFlagAsEnums
```
public Set<GeneralPurposeFlag> getGeneralPurposeFlagAsEnums()
```
    Return the set of GeneralPurposeFlag enums that make up the general-purpose-flags.
  - addGeneralPurposeFlag
```
public void addGeneralPurposeFlag(GeneralPurposeFlag generalPurposeFlag)
```
    Add a general-purpose-flag as an enum. This adds to the value set by setGeneralPurposeFlags(int).
  - withGeneralPurposeFlag
```
public ZipFileHeader.Builder withGeneralPurposeFlag(GeneralPurposeFlag generalPurposeFlag)
```
    Sets the general-purpose-flag as a an enums. This adds to the value set by setGeneralPurposeFlags(int).
  - clearGeneralPurposeFlag
```
public void clearGeneralPurposeFlag(GeneralPurposeFlag generalPurposeFlag)
```
    Clear a general-purpose-flag as an enum. This changes the value set by setGeneralPurposeFlags(int).
  - addGeneralPurposeFlags
```
public void addGeneralPurposeFlags(Collection<GeneralPurposeFlag> generalPurposeFlagSet)
```
    Sets the general-purpose-flags as a set of enums. This adds to the value set by setGeneralPurposeFlags(int).
  - withGeneralPurposeFlags
```
public ZipFileHeader.Builder withGeneralPurposeFlags(Collection<GeneralPurposeFlag> generalPurposeFlagSet)
```
    Sets the general-purpose-flags as a set of enums. This adds to the value set by setGeneralPurposeFlags(int).
  - addGeneralPurposeFlags
```
public void addGeneralPurposeFlags(GeneralPurposeFlag... generalPurposeFlagEnums)
```
    Sets the general-purpose-flags as an array of enums. This adds to the value set by setGeneralPurposeFlags(int).
  - withGeneralPurposeFlags
```
public ZipFileHeader.Builder withGeneralPurposeFlags(GeneralPurposeFlag... generalPurposeFlagEnums)
```
    Sets the general-purpose-flags as an array of enums. This adds to the value set by setGeneralPurposeFlags(int).
  - getCompressionMethod
```
public int getCompressionMethod()
```
  - setCompressionMethod
```
public void setCompressionMethod(int compressionMethod)
```
  - withCompressionMethod
```
public ZipFileHeader.Builder withCompressionMethod(int compressionMethod)
```
  - getCompressionMethodAsEnum
```
public CompressionMethod getCompressionMethodAsEnum()
```
  - setCompressionMethod
```
public void setCompressionMethod(CompressionMethod method)
```
  - withCompressionMethod
```
public ZipFileHeader.Builder withCompressionMethod(CompressionMethod method)
```
  - getLastModifiedTime
```
public int getLastModifiedTime()
```
    Last modified time in the MS-DOS time format.
  - setLastModifiedTime
```
public void setLastModifiedTime(int lastModifiedTime)
```
    Last modified time in the MS-DOS time format.
  - withLastModifiedTime
```
public ZipFileHeader.Builder withLastModifiedTime(int lastModifiedTime)
```
    Last modified time in the MS-DOS time format.
  - getLastModifiedDate
```
public int getLastModifiedDate()
```
    Last modified date in the MS-DOS date format.
  - setLastModifiedDate
```
public void setLastModifiedDate(int lastModifiedDate)
```
    Last modified date in the MS-DOS date format.
  - withLastModifiedDate
```
public ZipFileHeader.Builder withLastModifiedDate(int lastModifiedDate)
```
    Last modified date in the MS-DOS date format.
  - setLastModifiedDateTime
```
public void setLastModifiedDateTime(java.time.LocalDateTime lastModifiedDateTime)
```
    Set the lastModFileDate and lastModFileTime as a LocalDateTime. Warning, the time has a 2 second resolution so some normalization will occur.
  - withLastModifiedDateTime
```
public ZipFileHeader.Builder withLastModifiedDateTime(java.time.LocalDateTime lastModifiedDateTime)
```
    Set the lastModFileDate and lastModFileTime as a LocalDateTime. Warning, the time has a 2 second resolution so some normalization will occur.
  - setLastModifiedDateTime
```
public void setLastModifiedDateTime(long dateTimeMillis)
```
    Set the lastModFileDate and lastModFileTime as an epoch milliseconds. Warning, the time has a 2 second resolution so some normalization will occur.
  - withLastModifiedDateTime
```
public ZipFileHeader.Builder withLastModifiedDateTime(long dateTimeMillis)
```
    Set the lastModFileDate and lastModFileTime as an epoch milliseconds. Warning, the time has a 2 second resolution so some normalization will occur.
  - setLastModifiedDateTime
```
public void setLastModifiedDateTime(File file)
```
    Set the lastModFileDate and lastModFileTime from epoch milliseconds last-modified value from the File. Warning, the time has a 2 second resolution so some normalization will occur.
  - withLastModifiedDateTime
```
public ZipFileHeader.Builder withLastModifiedDateTime(File file)
```
    Set the lastModFileDate and lastModFileTime from epoch milliseconds last-modified value from the File. Warning, the time has a 2 second resolution so some normalization will occur.
  - getCrc32
```
public long getCrc32()
```
  - setCrc32
```
public void setCrc32(long crc32)
```
    Set to the crc checksum of the uncompressed bytes. This can be left as 0 if you want a ZipDataDescriptor written after the file data or if you have buffered enabled via ZipFileOutput.enableFileBuffering(int, int).
  - withCrc32
```
public ZipFileHeader.Builder withCrc32(long crc32)
```
  - setCrc32Value
```
public void setCrc32Value(CRC32 crc32)
```
  - getCompressedSize
```
public long getCompressedSize()
```
  - setCompressedSize
```
public void setCompressedSize(long compressedSize)
```
    Set to the compressed (encoded) size of the bytes. This can be left as 0 if you want a ZipDataDescriptor written after the file data or if you have buffered enabled via ZipFileOutput.enableFileBuffering(int, int). If this value is less than 0 or more than 0xFFFFFFFF then a Zip64 extra field will be written into the extra bytes if not otherwise specified. You can also set this to 0xFFFFFFFF and add a Zip64ExtraField to the setExtraFieldBytes(byte[]) or setZip64ExtraField(Zip64ExtraField).
  - withCompressedSize
```
public ZipFileHeader.Builder withCompressedSize(long compressedSize)
```
    Set to the compressed (encoded) size of the bytes. See setCompressedSize(long) for more details.
  - getUncompressedSize
```
public long getUncompressedSize()
```
  - setUncompressedSize
```
public void setUncompressedSize(long uncompressedSize)
```
    Set to the uncompressed (unencoded) size of the bytes. If this value is less than 0 or more than 0xFFFFFFFF then a Zip64 extra field will be written into the extra bytes if not otherwise specified. You can also set this to 0xFFFFFFFF and add a Zip64ExtraField to the setExtraFieldBytes(byte[]) or setZip64ExtraField(Zip64ExtraField).
  - withUncompressedSize
```
public ZipFileHeader.Builder withUncompressedSize(long uncompressedSize)
```
    Set to the uncompressed (unencoded) size of the bytes. See setUncompressedSize(long) for more details.
  - getFileNameBytes
```
public byte[] getFileNameBytes()
```
  - setFileNameBytes
```
public void setFileNameBytes(byte[] fileName)
```
  - withFileNameBytes
```
public ZipFileHeader.Builder withFileNameBytes(byte[] fileName)
```
  - getFileName
```
public String getFileName()
```
  - setFileName
```
public void setFileName(String fileName)
```
  - withFileName
```
public ZipFileHeader.Builder withFileName(String fileName)
```
  - getExtraFieldBytes
```
public byte[] getExtraFieldBytes()
```
  - setExtraFieldBytes
```
public void setExtraFieldBytes(byte[] extraFieldBytes)
```
    Set the extra-field-bytes. NOTE: This will interrogate the array looking for a Zip64ExtraField.
  - withExtraFieldBytes
```
public ZipFileHeader.Builder withExtraFieldBytes(byte[] extraFieldBytes)
```
    Set the extra-field-bytes. NOTE: This will interrogate the array looking for a Zip64ExtraField.
  - addExtraField
```
public ZipFileHeader.Builder addExtraField(BaseExtraField extraField)
```
    Add an extra field to the header other than the setZip64ExtraField(Zip64ExtraField). You should most likely either call setExtraFieldBytes(byte[]) or this method.
  - getZip64ExtraField
```
public Zip64ExtraField getZip64ExtraField()
```
  - setZip64ExtraField
```
public void setZip64ExtraField(Zip64ExtraField zip64ExtraField)
```
  - withZip64ExtraField
```
public ZipFileHeader.Builder withZip64ExtraField(Zip64ExtraField zip64ExtraField)
```

Class ZipFileHeader.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

fromHeader

fromFile

reset

getVersionNeeded

setVersionNeeded

withVersionNeeded

setVersionNeededMajorMinor

withVersionNeededMajorMinor

getGeneralPurposeFlags

setGeneralPurposeFlags

withGeneralPurposeFlags

assignGeneralPurposeFlag

getGeneralPurposeFlagAsEnums

addGeneralPurposeFlag

withGeneralPurposeFlag

clearGeneralPurposeFlag

addGeneralPurposeFlags

withGeneralPurposeFlags

addGeneralPurposeFlags

withGeneralPurposeFlags

getCompressionMethod

setCompressionMethod

withCompressionMethod

getCompressionMethodAsEnum

setCompressionMethod

withCompressionMethod

getLastModifiedTime

setLastModifiedTime

withLastModifiedTime

getLastModifiedDate

setLastModifiedDate

withLastModifiedDate

setLastModifiedDateTime

withLastModifiedDateTime

setLastModifiedDateTime

withLastModifiedDateTime

setLastModifiedDateTime

withLastModifiedDateTime

getCrc32

setCrc32

withCrc32

setCrc32Value

getCompressedSize

setCompressedSize

withCompressedSize

getUncompressedSize

setUncompressedSize

withUncompressedSize

getFileNameBytes

setFileNameBytes

withFileNameBytes

getFileName

setFileName

withFileName

getExtraFieldBytes

setExtraFieldBytes

withExtraFieldBytes

addExtraField

getZip64ExtraField

setZip64ExtraField

withZip64ExtraField