Package com.aspose.zip

Class CabEntry

java.lang.Object

com.aspose.zip.CabEntry

All Implemented Interfaces:

IArchiveFileEntry

public final class CabEntry
extends Object
implements IArchiveFileEntry

Represents a single file within cab archive.

Method Summary

Modifier and Type	Method	Description
void	extract(OutputStream destination)	Extracts the entry to the stream provided.
File	extract(String path)	Extracts the entry to the filesystem by the path provided.
Long	getLength()	Gets the length of the entry in bytes.
Date	getModificationTime()	Gets last modified date and time.
String	getName()	Gets the name of the entry within the archive.
InputStream	open()	Opens the entry for extraction and provides a stream with entry content.
String	toString()	Returns string representation of the instance of the CabEntry class.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getName

public final String getName()

Gets the name of the entry within the archive.

Specified by:

getName in interface IArchiveFileEntry

Returns:

the name of the entry within the archive

getLength

public final Long getLength()

Gets the length of the entry in bytes.

Specified by:

getLength in interface IArchiveFileEntry

Returns:

the length of the entry in bytes

getModificationTime

public final Date getModificationTime()

Gets last modified date and time.

Returns:

last modified date and time.

open

public final InputStream open()

Opens the entry for extraction and provides a stream with entry content.

Usage:

     CabArchive archive = new CabArchive("archive.cab");
     CabEntry entry = archive.getEntries().get(0);
     try (FileOutputStream fileStream = new FileOutputStream("data.bin")) {
         try (InputStream decompressed = entry.open()) {
             byte[] buffer = new byte[8192];
             int bytesRead;
             while (0 < (bytesRead = decompressed.read(buffer, 0, buffer.length))) {
                 fileStream.write(buffer, 0, bytesRead);
             }
         }
     } catch (IOException ex) {
     }
 

Read from the stream to get the original content of a file. See examples section.

Returns:

the stream that represents the contents of the entry

Throws:

com.aspose.ms.System.NotSupportedException - Stream initialization failed due to wrong data.

com.aspose.ms.System.IO.InvalidDataException - The archive is corrupted.

extract

public final File extract(String path)

Extracts the entry to the filesystem by the path provided.

     try (CabArchive archive = new CabArchive("archive.cab")) {
         archive.getEntries().get(0).extract("data.bin");
     }
 

Specified by:

extract in interface IArchiveFileEntry

Parameters:

path - the path to destination file. If the file already exists, it will be overwritten

Returns:

the file info of a composed file

Throws:

com.aspose.ms.System.ArgumentNullException - path is null.

com.aspose.ms.System.SecurityException - The caller does not have the required permission to access.

com.aspose.ms.System.ArgumentException - The path is empty, contains only white spaces, or contains invalid characters.

com.aspose.ms.System.IO.PathTooLongException - The specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters.

com.aspose.ms.System.NotSupportedException - File at path contains a colon (:) in the middle of the string.

com.aspose.ms.System.IO.FileNotFoundException - The file is not found.

com.aspose.ms.System.IO.DirectoryNotFoundException - The specified path is invalid, such as being on an unmapped drive.

com.aspose.ms.System.IO.IOException - The file is already open.

com.aspose.ms.System.NotSupportedException - Stream initialization failed due to wrong data.

com.aspose.ms.System.IO.InvalidDataException - The archive is corrupted.

extract

public final void extract(OutputStream destination)

Extracts the entry to the stream provided.

Extract an entry of cab archive.

     try (CabArchive archive = new CabArchive("archive.cab")) {
         archive.getEntries().get(0).extract(httpResponseStream);
     }
 

Specified by:

extract in interface IArchiveFileEntry

Parameters:

destination - destination stream. Must be writable

Throws:

com.aspose.ms.System.ArgumentException - destination does not support writing.

com.aspose.ms.System.NotSupportedException - Stream initialization failed due to wrong data.

com.aspose.ms.System.IO.InvalidDataException - The archive is corrupted.

toString

public String toString()

Returns string representation of the instance of the CabEntry class.

Overrides:

toString in class Object

Returns:

string representation of this object