package com.atlassian.core.util.zip;
   
   import javax.annotation.concurrent.Immutable;
   
   @Immutable
   public class ArchiveParams
   {
       private final String archiveFolderName;
       private final boolean includeHiddenFiles;
  
      private ArchiveParams(Builder builder)
      {
          this.archiveFolderName = builder.archiveFolderName;
          this.includeHiddenFiles = builder.includeHiddenFiles;
      }
  
      public String getArchiveFolderName()
      {
          return archiveFolderName;
      }
  
      public boolean isIncludeHiddenFiles()
      {
          return includeHiddenFiles;
      }
  
      public static Builder builder()
      {
          return new Builder();
      }
  
      public static class Builder
      {
          private String archiveFolderName;
          private boolean includeHiddenFiles = true;
  
          private Builder()
          {
  
          }
  
          /**
           * The path used as target directory within archive, so all files and directories
           * inside archive will start with this path. For example when {@code folderToCompress}
           * is pointing into /home/A/B directory which contains file with path /home/A/B/C/file
           * and {@code archiveFolderName} equals "archive" a result zip archive will contain
           * entry: /archive/C/file
           */
          public Builder withArchiveFolderName(String archiveFolderName)
          {
              this.archiveFolderName = archiveFolderName;
              return this;
          }
  
          /**
           * Should hidden files be included in the archive.
           */
          public Builder withIncludeHiddenFiles(boolean includeHiddenFiles)
          {
              this.includeHiddenFiles = includeHiddenFiles;
              return this;
          }
  
          public ArchiveParams build()
          {
              return new ArchiveParams(this);
          }
      }
  }