com.starbase.starteam
Class FileStream

java.lang.Object
  |
  +--com.starbase.starteam.FileStream

public class FileStream

extends java.lang.Object

Provides utility function for manipulating File streams.

Constructor Summary

FileStream()
Deprecated.

Method Summary

static int	computeCompareMD5(java.io.File file, boolean bUsesKeywords, boolean bConvertEOL, MD5 md5) Deprecated. Use computeCompareMD5Ex, which supports file sizes greater than 2GB.
static long	computeCompareMD5Ex(java.io.File file, boolean bUsesKeywords, boolean bConvertEOL, MD5 md5) Derives an MD5 signature representing what the content of the given file would be if stored in the StarTeam repository.
static int	computeSyncMD5(java.io.File file, MD5 md5) Deprecated. Use computeSyncMD5Ex, which supports file sizes greater than 2GB.
static long	computeSyncMD5Ex(java.io.File file, MD5 md5) Derives an MD5 signature representing an actual working file on disk.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileStream

public FileStream()

Deprecated.

Method Detail

computeSyncMD5

public static int computeSyncMD5(java.io.File file,
                                 MD5 md5)
                          throws java.io.IOException

Deprecated. Use computeSyncMD5Ex, which supports file sizes greater than 2GB.

Derives an MD5 signature representing an actual working file on disk.

Parameters:

file - The working file on disk. An exception will be thrown if the file does not exist or cannot be read.

md5 - A newly initialized MD5 signature. On output, contains the MD5 signature calculated from the file's content.

Returns:

The number of bytes in the working file on disk.

java.io.IOException

See Also:

FileStream.computeCompareMD5(java.io.File, boolean, boolean, com.starbase.util.MD5), File.resyncStatus(com.starbase.util.MD5, int, com.starbase.util.MD5, int, com.starbase.util.OLEDate), Status, FileStream.computeSyncMD5Ex(java.io.File, com.starbase.util.MD5)

computeSyncMD5Ex

public static long computeSyncMD5Ex(java.io.File file,
                                    MD5 md5)
                             throws java.io.IOException

Derives an MD5 signature representing an actual working file on disk.

Parameters:

file - The working file on disk. An exception will be thrown if the file does not exist or cannot be read.

md5 - A newly initialized MD5 signature. On output, contains the MD5 signature calculated from the file's content.

Returns:

The number of bytes in the working file on disk.

java.io.IOException

See Also:

FileStream.computeCompareMD5(java.io.File, boolean, boolean, com.starbase.util.MD5), File.resyncStatus(com.starbase.util.MD5, int, com.starbase.util.MD5, int, com.starbase.util.OLEDate), Status

computeCompareMD5

public static int computeCompareMD5(java.io.File file,
                                    boolean bUsesKeywords,
                                    boolean bConvertEOL,
                                    MD5 md5)
                             throws java.io.IOException

Deprecated. Use computeCompareMD5Ex, which supports file sizes greater than 2GB.

Derives an MD5 signature representing what the content of the given file would be if stored in the StarTeam repository.

Compensates for the effects of expanding keywords and performing end-of-line conversion on checkout.

Parameters:

file - The working file on disk. An exception will be thrown if the file does not exist or cannot be read.

md5 - A newly initialized MD5 signature. On output, contains the MD5 signature calculated from the file's content, adjusted as determined by bUsesKeywords and bConvertEOL.

bUsesKeywords - True if this file uses keywords. If true, then the signature is adjusted to compensate for any keyword expansion that would occur on a checkin. If this is a binary file (that is, if it contains at least one '\0' character), bUsesKeywords is ignored, and no adjustment is made to the signature.

bConvertEOL - True if end-of-line conversion is performed on this file. If true, then the signature is adjusted to compensate for end-of-line conversion that would occur on a checkin. If this is a binary file (that is, if it contains at least one '\0' character), bUsesKeywords is ignored, and no adjustment is made to the signature.

Returns:

The number of bytes in the as it would be stored in the StarTeam repository.

java.io.IOException

See Also:

FileStream.computeSyncMD5(java.io.File, com.starbase.util.MD5), File.resyncStatus(com.starbase.util.MD5, int, com.starbase.util.MD5, int, com.starbase.util.OLEDate), Status, FileStream.computeCompareMD5Ex(java.io.File, boolean, boolean, com.starbase.util.MD5)

computeCompareMD5Ex

public static long computeCompareMD5Ex(java.io.File file,
                                       boolean bUsesKeywords,
                                       boolean bConvertEOL,
                                       MD5 md5)
                                throws java.io.IOException

Derives an MD5 signature representing what the content of the given file would be if stored in the StarTeam repository.

Compensates for the effects of expanding keywords and performing end-of-line conversion on checkout.

Parameters:

file - The working file on disk. An exception will be thrown if the file does not exist or cannot be read.

md5 - A newly initialized MD5 signature. On output, contains the MD5 signature calculated from the file's content, adjusted as determined by bUsesKeywords and bConvertEOL.

bUsesKeywords - True if this file uses keywords. If true, then the signature is adjusted to compensate for any keyword expansion that would occur on a checkin. If this is a binary file (that is, if it contains at least one '\0' character), bUsesKeywords is ignored, and no adjustment is made to the signature.

bConvertEOL - True if end-of-line conversion is performed on this file. If true, then the signature is adjusted to compensate for end-of-line conversion that would occur on a checkin. If this is a binary file (that is, if it contains at least one '\0' character), bUsesKeywords is ignored, and no adjustment is made to the signature.

Returns:

The number of bytes in the as it would be stored in the StarTeam repository.

java.io.IOException

See Also:

FileStream.computeSyncMD5(java.io.File, com.starbase.util.MD5), File.resyncStatus(com.starbase.util.MD5, int, com.starbase.util.MD5, int, com.starbase.util.OLEDate), Status