Class GzipParameters
- java.lang.Object
-
- org.apache.commons.compress.compressors.gzip.GzipParameters
-
public class GzipParameters extends java.lang.ObjectParameters for the GZIP compressor.- Since:
- 1.7
- See Also:
GzipCompressorInputStream,GzipCompressorOutputStream
-
-
Constructor Summary
Constructors Constructor Description GzipParameters()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetBufferSize()Gets size of the buffer used to retrieve compressed data.java.lang.StringgetComment()intgetCompressionLevel()intgetDeflateStrategy()Gets the deflater strategy.java.lang.StringgetFilename()longgetModificationTime()intgetOperatingSystem()voidsetBufferSize(int bufferSize)Sets size of the buffer used to retrieve compressed data fromDeflaterand write to underlyingOutputStream.voidsetComment(java.lang.String comment)voidsetCompressionLevel(int compressionLevel)Sets the compression level.voidsetDeflateStrategy(int deflateStrategy)Sets the deflater strategy.voidsetFilename(java.lang.String fileName)Sets the name of the compressed file.voidsetModificationTime(long modificationTime)Sets the modification time of the compressed file.voidsetOperatingSystem(int operatingSystem)Sets the operating system on which the compression took place.
-
-
-
Method Detail
-
getBufferSize
public int 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:
setBufferSize(int)
-
getComment
public java.lang.String getComment()
-
getCompressionLevel
public int getCompressionLevel()
-
getDeflateStrategy
public int getDeflateStrategy()
Gets the deflater strategy.- Returns:
- the deflater strategy,
Deflater.DEFAULT_STRATEGYby default. - Since:
- 1.23
- See Also:
setDeflateStrategy(int),Deflater.setStrategy(int)
-
getFilename
public java.lang.String getFilename()
-
getModificationTime
public long getModificationTime()
-
getOperatingSystem
public int getOperatingSystem()
-
setBufferSize
public void setBufferSize(int bufferSize)
Sets size of the buffer used to retrieve compressed data fromDeflaterand write to underlyingOutputStream.- Parameters:
bufferSize- the bufferSize to set. Must be a positive value.- Since:
- 1.21
-
setComment
public void setComment(java.lang.String comment)
-
setCompressionLevel
public void setCompressionLevel(int compressionLevel)
Sets the compression level.- Parameters:
compressionLevel- the compression level (between 0 and 9)- See Also:
Deflater.NO_COMPRESSION,Deflater.BEST_SPEED,Deflater.DEFAULT_COMPRESSION,Deflater.BEST_COMPRESSION
-
setDeflateStrategy
public void setDeflateStrategy(int deflateStrategy)
Sets the deflater strategy.- Parameters:
deflateStrategy- the new compression strategy- Since:
- 1.23
- See Also:
Deflater.setStrategy(int)
-
setFilename
public void setFilename(java.lang.String fileName)
Sets the name of the compressed file.- Parameters:
fileName- the name of the file without the directory path
-
setModificationTime
public void setModificationTime(long modificationTime)
Sets the modification time of the compressed file.- Parameters:
modificationTime- the modification time, in milliseconds
-
setOperatingSystem
public void setOperatingSystem(int operatingSystem)
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
-
-