/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.commons.compress.compressors.gzip;

import java.util.zip.Deflater;

Parameters for the GZIP compressor.
Since:1.7
/** * Parameters for the GZIP compressor. * * @since 1.7 */
public class GzipParameters { private int compressionLevel = Deflater.DEFAULT_COMPRESSION; private long modificationTime; private String filename; private String comment; private int operatingSystem = 255; // Unknown OS by default public int getCompressionLevel() { return compressionLevel; }
Sets the compression level.
Params:
  • compressionLevel – the compression level (between 0 and 9)
See Also:
/** * Sets the compression level. * * @param compressionLevel the compression level (between 0 and 9) * @see Deflater#NO_COMPRESSION * @see Deflater#BEST_SPEED * @see Deflater#DEFAULT_COMPRESSION * @see Deflater#BEST_COMPRESSION */
public void setCompressionLevel(final int compressionLevel) { if (compressionLevel < -1 || compressionLevel > 9) { throw new IllegalArgumentException("Invalid gzip compression level: " + compressionLevel); } this.compressionLevel = compressionLevel; } public long getModificationTime() { return modificationTime; }
Sets the modification time of the compressed file.
Params:
  • modificationTime – the modification time, in milliseconds
/** * Sets the modification time of the compressed file. * * @param modificationTime the modification time, in milliseconds */
public void setModificationTime(final long modificationTime) { this.modificationTime = modificationTime; } public String getFilename() { return filename; }
Sets the name of the compressed file.
Params:
  • fileName – the name of the file without the directory path
/** * Sets the name of the compressed file. * * @param fileName the name of the file without the directory path */
public void setFilename(final String fileName) { this.filename = fileName; } public String getComment() { return comment; } public void setComment(final String comment) { this.comment = comment; } public int getOperatingSystem() { return 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
Params:
  • operatingSystem – the code of the operating system
/** * Sets the operating system on which the compression took place. * The defined values are: * <ul> * <li>0: FAT file system (MS-DOS, OS/2, NT/Win32)</li> * <li>1: Amiga</li> * <li>2: VMS (or OpenVMS)</li> * <li>3: Unix</li> * <li>4: VM/CMS</li> * <li>5: Atari TOS</li> * <li>6: HPFS file system (OS/2, NT)</li> * <li>7: Macintosh</li> * <li>8: Z-System</li> * <li>9: CP/M</li> * <li>10: TOPS-20</li> * <li>11: NTFS file system (NT)</li> * <li>12: QDOS</li> * <li>13: Acorn RISCOS</li> * <li>255: Unknown</li> * </ul> * * @param operatingSystem the code of the operating system */
public void setOperatingSystem(final int operatingSystem) { this.operatingSystem = operatingSystem; } }