java.util.zip.ZipOutputStream.setComment() Method Example

Description

The java.util.zip.ZipOutputStream.setComment(String comment) method sets the ZIP file comment.

Declaration

Following is the declaration for java.util.zip.ZipOutputStream.setComment(String comment) method.

public void setComment(String comment)

Parameters

• comment − The comment string.

Exceptions

• IllegalArgumentException − If the length of the specified ZIP file comment is greater than 0xFFFF bytes.

Pre-requisite

Create a file Hello.txt in D:> test > directory with the following content.

This is an example.

Example

The following example shows the usage of java.util.zip.ZipOutputStream.setComment(String comment) method.

package com.tutorialspoint;

import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.Date;
import java.util.zip.Adler32;
import java.util.zip.CheckedOutputStream;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;
import java.util.zip.ZipOutputStream;

public class ZipOutputStreamDemo {
   private static String SOURCE_FILE = "D:\\test\\Hello.txt";
   private static String TARGET_FILE = "D:\\test\\Hello.zip";

   public static void main(String[] args) {
      try {
         createZipFile();
         readZipFile();
      } catch(IOException ioe) {
         System.out.println("IOException : " + ioe);
      }
   }

   private static void createZipFile() throws IOException{
      FileOutputStream fout = new FileOutputStream(TARGET_FILE);
      CheckedOutputStream checksum = new CheckedOutputStream(fout, new Adler32());
      ZipOutputStream zout = new ZipOutputStream(checksum);

      FileInputStream fin = new FileInputStream(SOURCE_FILE);
      ZipEntry zipEntry = new ZipEntry(SOURCE_FILE);
      zout.putNextEntry(zipEntry);
      zout.setComment("This is a sample comment.");
      int length;
      byte[] buffer = new byte[1024];
      while((length = fin.read(buffer)) > 0) {
         zout.write(buffer, 0, length);
      }

      zout.closeEntry();
      zout.finish();
      fin.close();
      zout.close();
   }

   private static void readZipFile() throws IOException{
      ZipInputStream zin = new ZipInputStream(new FileInputStream(TARGET_FILE)); 

      ZipEntry entry;
      while((entry = zin.getNextEntry())!=null){
         System.out.printf("File: %s Modified on %TD %n", 
         entry.getName(), new Date(entry.getTime()));
         System.out.println(file.getComment());
         extractFile(entry, zin); 
         System.out.printf("Zip file %s extracted successfully.", SOURCE_FILE);
         zin.closeEntry();
      }
      zin.close();
   }

   private static void extractFile(final ZipEntry entry, ZipInputStream is) 
      throws IOException {
      FileOutputStream fos = null; 
      try { 
         fos = new FileOutputStream(entry.getName()); 
         while(is.available() != 0){
            fos.write(is.read()); 
         }
      } catch (IOException ioex) { 
         fos.close(); 
      } 
   }
}

Let us compile and run the above program, this will produce the following result −

Zip File: D:\test\Hello.zip, Contains 1 file(s). 
File: D:\test\Hello.txt Size 1026 Modified on 05/22/17 
This is a sample comment.
Zip file D:\test\Hello.txt extracted successfully.