Class CabFolderEntry

public final class CabFolderEntry implements CabConstants
{
  // Constructors
  public CabFolderEntry();

  // Methods
  public String compressionToString();
  public int getCompressionMethod();
  public int getCompressionWindowSize();
  public void setCompression(int compression_method,
        int window_bits) throws CabException;
}

This class implements objects that represent folders in a cabinet file. CabFolderEntry items represent folders in the cabinet. A CabFolderEntry object must be passed to the newFolder method of the CabCreator class. CabFolderEntry objects can also be returned using the entries method of the CabDecoder class.

For more information, see the CabFileEntry, CabCreator, and CabDecoder classes.

Constructors

CabFolderEntry

public CabFolderEntry();

Initializes the new folder.

Methods

compressionToString

public String compressionToString();

Retrieves a string representation of the compression parameters containing the compression method and window bits (if applicable).

Return Value:

Returns a string containing compression parameters.

getCompressionMethod

public int getCompressionMethod();

Retrieves the compression method used in this folder.

Return Value:

Returns the method of compression.

getCompressionWindowSize

public int getCompressionWindowSize();

Retrieves the compression window size.

Return Value:

Returns the natural logarithm of the window history size used in compression.

setCompression

public void setCompression(int compression_method, int window_bits)
        throws CabException;

Sets the compression parameters to be used for this folder.

Return Value:

No return value.

Parameter	Description
compression_method	The compression method used, as defined in the CabConstants class.
window_bits	The History window size to use. For information about valid values, see the CabConstants class.

Exceptions:

com.ms.util.cab.CabException if one or more of the parameters are invalid.