Thursday, December 11, 2025
HomeLanguagesJavaJava ZipEntry setComment() function with examples

Java ZipEntry setComment() function with examples

The setComment() function is a part of java.util.zip package. The function sets the Comment of a specific ZipEntry to the specified string.
Maximum length of comment is 0xffff, if the length of the string is larger than 0xffff then first 0xffff characters will be considered.
Function Signature :

public void setComment(String s)

Syntax :

zip_entry.setComment(s);

Parameters :The function accepts a String object as parameter.
Return value :The function does not return any value.
Exceptions :The function does not throw any exception.

Below programs illustrates the use of setComment() function

Example 1: We will create a file named zip_file and get the zip file entry using getEntry() function and then set the comment of the specified ZipEntry.”file.zip” is a zip file present in f: directory.




// Java program to demonstrate the
// use of setComment() function
  
import java.util.zip.*;
import java.util.Enumeration;
import java.util.*;
import java.io.*;
  
public class solution {
    public static void main(String args[])
    {
        try {
            // Create a Zip File
            ZipFile zip_file = new ZipFile("f:\\file1.zip");
  
            // get the Zip Entry using
            // the getEntry() function
            ZipEntry entry = zip_file.getEntry("file.zip");
  
            // get the Comment
            // using the getComment()
            // function
            entry.setComment("This is a ZipEntry comment");
  
            // get the Comment
            // using the getComment()
            // function
            String input = entry.getComment();
  
            // Display the comment
            System.out.println("Comment : " + input);
        }
        catch (Exception e) {
            System.out.println(e.getMessage());
        }
    }
}


Output:

Comment : This is a Zip Entry comment)

Reference: https://docs.oracle.com/javase/9/docs/api/java/util/zip/ZipEntry.html#setComment-java.lang.String-

RELATED ARTICLES

Most Popular

Dominic
32442 POSTS0 COMMENTS
Milvus
105 POSTS0 COMMENTS
Nango Kala
6813 POSTS0 COMMENTS
Nicole Veronica
11950 POSTS0 COMMENTS
Nokonwaba Nkukhwana
12025 POSTS0 COMMENTS
Shaida Kate Naidoo
6943 POSTS0 COMMENTS
Ted Musemwa
7196 POSTS0 COMMENTS
Thapelo Manthata
6889 POSTS0 COMMENTS
Umr Jansen
6880 POSTS0 COMMENTS