Package com.ms.util.cab

Previous

Contents

Index

Next

Class CabFolderEntry

public final class CabFolderEntry implements CabConstants {
  // Constructors
  public CabFolderEntry();
  // Methods
  public int getCompressionMethod();
  public int getCompressionWindowSize();
  public void setCompression(int compression_method, int window_bits)
		throws CabException;
  public String compressionToString();
}

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 also CabFileEntry, CabCreator, and CabDecoder.

Constructors

CabFolderEntry

public CabFolderEntry();

Initializes the new folder.

Methods

compressionToString

public String compressionToString();

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

getCompressionMethod

public int getCompressionMethod();

Returns the compression method used in this folder.

getCompressionWindowSize

public int getCompressionWindowSize();

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 to be used for this folder.

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

Exceptions:

CabException Thrown if the supplied parameters are invalid.