Class GzipParameters
- Since:
- 1.7
- See Also:
-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanintGets size of the buffer used to retrieve compressed data.Gets an arbitrary user-defined comment.intGets the compression level.intGets the deflater strategy.Gets the Extra subfields from the header.Deprecated.Gets the file name.Gets the Charset to use for writing file names and comments.booleanReturns if the header CRC is to be added (when writing) or was present (when reading).Gets the most recent modification time (MTIME) of the original file being compressed.longGets the most recent modification time (MTIME) of the original file being compressed, in seconds since 00:00:00 GMT, Jan. 1, 1970.intGets the OS code type.getOS()Gets the OS type.longGets the trailer CRC value.longGets the trailer ISIZE value.inthashCode()voidsetBufferSize(int bufferSize) Sets size of the buffer used to retrieve compressed data fromDeflaterand write to underlyingOutputStream.voidsetComment(String comment) Sets an arbitrary user-defined comment.voidsetCompressionLevel(int compressionLevel) Sets the compression level.voidsetDeflateStrategy(int deflateStrategy) Sets the deflater strategy.voidsetExtraField(ExtraField extra) Sets the extra subfields.voidsetFilename(String fileName) Deprecated.UsesetFileName(String).voidsetFileName(String fileName) Sets the name of the compressed file.voidsetFileNameCharset(Charset charset) Sets the Charset to use for writing file names and comments, where null maps toGzipUtils.GZIP_ENCODING.voidsetHeaderCRC(boolean headerCRC) Establishes the presence of the header flag FLG.FHCRC and its headers CRC16 value.voidsetModificationInstant(Instant modificationTime) Sets the modification time (MTIME) of the compressed file.voidsetModificationTime(long modificationTimeSeconds) Sets the modification time (MTIME) of the compressed file, in seconds since 00:00:00 GMT, Jan. 1, 1970.voidsetOperatingSystem(int operatingSystem) Sets the operating system on which the compression took place.voidSets the operating system on which the compression took place.toString()
-
Constructor Details
-
GzipParameters
public GzipParameters()
-
-
Method Details
-
equals
-
getBufferSize
Gets size of the buffer used to retrieve compressed data.- Returns:
- The size of the buffer used to retrieve compressed data.
- Since:
- 1.21
- See Also:
-
getComment
Gets an arbitrary user-defined comment.- Returns:
- a user-defined comment.
-
getCompressionLevel
Gets the compression level.- Returns:
- the compression level.
- See Also:
-
getDeflateStrategy
Gets the deflater strategy.- Returns:
- the deflater strategy,
Deflater.DEFAULT_STRATEGYby default. - Since:
- 1.23
- See Also:
-
getExtraField
Gets the Extra subfields from the header.- Returns:
- the extra subfields from the header.
- Since:
- 1.28.0
-
getFilename
Deprecated.UsegetFileName().Gets the file name.- Returns:
- the file name.
-
getFileName
Gets the file name.- Returns:
- the file name.
- Since:
- 1.25.0
-
getFileNameCharset
Gets the Charset to use for writing file names and comments.The default value is
GzipUtils.GZIP_ENCODING.- Returns:
- the Charset to use for writing file names and comments.
- Since:
- 1.28.0
-
getHeaderCRC
Returns if the header CRC is to be added (when writing) or was present (when reading).- Returns:
- true is header CRC will be added (on write) or was found (after read).
- Since:
- 1.28.0
-
getModificationInstant
Gets the most recent modification time (MTIME) of the original file being compressed.- Returns:
- the most recent modification time.
- Since:
- 1.28.0
-
getModificationTime
Gets the most recent modification time (MTIME) of the original file being compressed, in seconds since 00:00:00 GMT, Jan. 1, 1970.The time is in Unix format, for example, seconds since 00:00:00 GMT, Jan. 1, 1970. (Note that this may cause problems for MS-DOS and other systems that use local rather than Universal time.) If the compressed data did not come from a file, MTIME is set to the time at which compression started. MTIME = 0 means no time stamp is available.
- Returns:
- the most recent modification time in seconds since 00:00:00 GMT, Jan. 1, 1970.
-
getOperatingSystem
Gets the OS code type.- Returns:
- the OS code type.
-
getOS
Gets the OS type.- Returns:
- the OS type.
- Since:
- 1.28.0
-
getTrailerCrc
Gets the trailer CRC value.- Returns:
- the trailer CRC value.
- Since:
- 1.28.0
-
getTrailerISize
Gets the trailer ISIZE value.- Returns:
- the trailer ISIZE value.
- Since:
- 1.28.0
-
hashCode
-
setBufferSize
Sets size of the buffer used to retrieve compressed data fromDeflaterand write to underlyingOutputStream.- Parameters:
bufferSize- the bufferSize to set. Must be a positive type.- Since:
- 1.21
-
setComment
Sets an arbitrary user-defined comment.- Parameters:
comment- a user-defined comment.- Throws:
IllegalArgumentException- if the encoded bytes would contain a nul byte '\0' reserved for gzip field termination.
-
setCompressionLevel
Sets the compression level.- Parameters:
compressionLevel- the compression level (between 0 and 9)- See Also:
-
setDeflateStrategy
Sets the deflater strategy.- Parameters:
deflateStrategy- the new compression strategy- Since:
- 1.23
- See Also:
-
setExtraField
Sets the extra subfields. Note that a non-null extra will appear in the gzip header regardless of the presence of subfields, while a null extra will not appear at all.- Parameters:
extra- the series of extra sub fields.- Since:
- 1.28.0
-
setFilename
Deprecated.UsesetFileName(String).Sets the name of the compressed file.- Parameters:
fileName- the name of the file without the directory path- Throws:
IllegalArgumentException- if the encoded bytes would contain a nul byte '\0' reserved for gzip field termination.
-
setFileName
Sets the name of the compressed file.- Parameters:
fileName- the name of the file without the directory path- Throws:
IllegalArgumentException- if the encoded bytes would contain a nul byte '\0' reserved for gzip field termination.
-
setFileNameCharset
Sets the Charset to use for writing file names and comments, where null maps toGzipUtils.GZIP_ENCODING.Setting a value other than
GzipUtils.GZIP_ENCODINGis not compliant with the RFC 1952 GZIP File Format Specification. Use at your own risk of interoperability issues.The default value is
GzipUtils.GZIP_ENCODING.- Parameters:
charset- the Charset to use for writing file names and comments, null maps toGzipUtils.GZIP_ENCODING.- Since:
- 1.28.0
-
setHeaderCRC
Establishes the presence of the header flag FLG.FHCRC and its headers CRC16 value.- Parameters:
headerCRC- when true, the header CRC16 (actually low 16 buts of a CRC32) is calculated and inserted in the gzip header on write; on read it means the field was present.- Since:
- 1.28.0
-
setModificationInstant
Sets the modification time (MTIME) of the compressed file.- Parameters:
modificationTime- the modification time, in milliseconds- Since:
- 1.28.0
-
setModificationTime
Sets the modification time (MTIME) of the compressed file, in seconds since 00:00:00 GMT, Jan. 1, 1970.The time is in Unix format, for example, seconds since 00:00:00 GMT, Jan. 1, 1970. (Note that this may cause problems for MS-DOS and other systems that use local rather than Universal time.) If the compressed data did not come from a file, MTIME is set to the time at which compression started. MTIME = 0 means no time stamp is available.
- Parameters:
modificationTimeSeconds- the modification time, in seconds.
-
setOperatingSystem
Sets the operating system on which the compression took place. The defined values are:- 0: FAT file system (MS-DOS, OS/2, NT/Win32)
- 1: Amiga
- 2: VMS (or OpenVMS)
- 3: Unix
- 4: VM/CMS
- 5: Atari TOS
- 6: HPFS file system (OS/2, NT)
- 7: Macintosh
- 8: Z-System
- 9: CP/M
- 10: TOPS-20
- 11: NTFS file system (NT)
- 12: QDOS
- 13: Acorn RISCOS
- 255: Unknown
- Parameters:
operatingSystem- the code of the operating system
-
setOS
Sets the operating system on which the compression took place.- Parameters:
os- operating system, null maps toGzipParameters.OS.UNKNOWN.- Since:
- 1.28.0
-
toString
-
getFileName().