/*
    * 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.io.OutputStream;
  import java.util.zip.Deflater;
  
  /**
   * Parameters for the GZIP compressor.
   *
   * @see GzipCompressorInputStream
   * @see GzipCompressorOutputStream
   * @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
      private int bufferSize = 512;
      private int deflateStrategy = Deflater.DEFAULT_STRATEGY;
  
      /**
       * Gets size of the buffer used to retrieve compressed data.
       *
       * @return The size of the buffer used to retrieve compressed data.
       * @since 1.21
       * @see #setBufferSize(int)
       */
      public int getBufferSize() {
          return this.bufferSize;
      }
  
      public String getComment() {
          return comment;
      }
  
      public int getCompressionLevel() {
          return compressionLevel;
      }
  
      /**
       * Gets the deflater strategy.
       *
       * @return the deflater strategy, {@link Deflater#DEFAULT_STRATEGY} by default.
       * @see #setDeflateStrategy(int)
       * @see Deflater#setStrategy(int)
       * @since 1.23
       */
      public int getDeflateStrategy() {
          return deflateStrategy;
      }
  
      /**
       * Gets the file name.
       *
       * @return the file name.
       * @deprecated Use {@link #getFileName()}.
       */
      @Deprecated
      public String getFilename() {
          return fileName;
      }
  
      /**
       * Gets the file name.
       *
       * @return the file name.
       * @since 2.25.0
       */
      public String getFileName() {
          return fileName;
      }
  
      public long getModificationTime() {
          return modificationTime;
      }
  
      public int getOperatingSystem() {
          return operatingSystem;
     }
 
     /**
      * Sets size of the buffer used to retrieve compressed data from {@link Deflater} and write to underlying {@link OutputStream}.
      *
      * @param bufferSize the bufferSize to set. Must be a positive value.
      * @since 1.21
      */
     public void setBufferSize(final int bufferSize) {
         if (bufferSize <= 0) {
             throw new IllegalArgumentException("invalid buffer size: " + bufferSize);
         }
         this.bufferSize = bufferSize;
     }
 
     public void setComment(final String comment) {
         this.comment = comment;
     }
 
     /**
      * 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;
     }
 
     /**
      * Sets the deflater strategy.
      *
      * @param deflateStrategy the new compression strategy
      * @see Deflater#setStrategy(int)
      * @since 1.23
      */
     public void setDeflateStrategy(final int deflateStrategy) {
         this.deflateStrategy = deflateStrategy;
     }
 
     /**
      * Sets the name of the compressed file.
      *
      * @param fileName the name of the file without the directory path
      * @deprecated Use {@link #setFileName(String)}.
      */
     @Deprecated
     public void setFilename(final String fileName) {
         this.fileName = fileName;
     }
 
     /**
      * 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;
     }
 
     /**
      * Sets the modification time of the compressed file.
      *
      * @param modificationTime the modification time, in milliseconds
      */
     public void setModificationTime(final long modificationTime) {
         this.modificationTime = modificationTime;
     }
 
     /**
      * 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;
     }
 }