com.starbase.starteam
Class FileBasedStatusManager

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

public class FileBasedStatusManager

extends java.lang.Object

Manages File Status information on the local client workstation.

See Also:

StatusMethod

Method Summary

void	deleteFileSyncInfo(java.io.File file, boolean cs) Deletes File Status information for the given working file.
boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
FileSyncInfo	getFileSyncInfo(java.io.File file, boolean cs) Gets File Status information for the given working file.
int	hashCode() returns a unique hash for all instances of this type
boolean	isCentral() Determines whether or not status information is centrally managed.
boolean	isPerFolder() Determines whether or not status information managed on a per-folder basis.
boolean	moveFileSyncInfo(java.io.File oldFile, java.io.File newFile, boolean caseSensitive) Moves File Status Information from the oldFile to the newFile The move will fail if either of the two specified files do not exist.
void	setFileSyncInfo(java.io.File file, FileSyncInfo rec, boolean cs) Sets File Status information for the given working file.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

isCentral

public boolean isCentral()

Determines whether or not status information is centrally managed.

Returns:

True if status information is stored in a central location; false if it is managed on a per-folder basis.

See Also:

FileBasedStatusManager.isPerFolder(), StatusMethod.PER_FOLDER

isPerFolder

public boolean isPerFolder()

Determines whether or not status information managed on a per-folder basis.

Returns:

True if status information is managed on a per-folder basis; false if it is stored in a central location.

See Also:

FileBasedStatusManager.isCentral(), StatusMethod.CENTRAL

getFileSyncInfo

public FileSyncInfo getFileSyncInfo(java.io.File file,
                                    boolean cs)
                             throws java.io.IOException

Gets File Status information for the given working file.

Parameters:

file - A working file.

cs - True if paths are case sensitive; false otherwise.

Returns:

File Status information for the given working file, or null if none is available.

Throws:

java.io.IOException - if there was a problem reading the File Status database on the local workstation.

See Also:

FileSyncInfo, StatusMethod

setFileSyncInfo

public void setFileSyncInfo(java.io.File file,
                            FileSyncInfo rec,
                            boolean cs)
                     throws java.io.IOException

Sets File Status information for the given working file.

Parameters:

file - A working file.

rec - New File Status information to be saved.

cs - True if paths are case sensitive; false otherwise.

Throws:

java.io.IOException - if there was a problem reading or writing the File Status database on the local workstation.

See Also:

FileSyncInfo, StatusMethod

deleteFileSyncInfo

public void deleteFileSyncInfo(java.io.File file,
                               boolean cs)
                        throws java.io.IOException

Deletes File Status information for the given working file.

Parameters:

file - A working file.

cs - True if paths are case sensitive; false otherwise.

Throws:

java.io.IOException - if there was a problem reading or writing the File Status database on the local workstation.

See Also:

FileSyncInfo, StatusMethod

moveFileSyncInfo

public boolean moveFileSyncInfo(java.io.File oldFile,
                                java.io.File newFile,
                                boolean caseSensitive)
                         throws java.io.IOException

Moves File Status Information from the oldFile to the newFile The move will fail if either of the two specified files do not exist.

Parameters:

oldFile - File a file for which status information is recorded; this status will be deleted as a result of the move

newFile - File a file to which the status information is being transferred

caseSensitive - boolean True if paths are case sensitive; false otherwise

Returns:

true if the move succeeded

Throws:

java.io.IOException - if there was a problem reading or writing the File Status database on the local workstation.

See Also:

FileSyncInfo, StatusMethod

equals

public boolean equals(java.lang.Object source)

returns true if this object instance is equal to the source

Overrides:

equals in class java.lang.Object

Parameters:

source - Object the source to comapre with

Returns:

boolean true if this object is equal to the source

hashCode

public int hashCode()

returns a unique hash for all instances of this type

Overrides:

hashCode in class java.lang.Object

Returns:

int a unique hash for all instances of this type