com.starbase.starteam
Class DirectoryOverrides

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

public class DirectoryOverrides

extends java.lang.Object

A class that can parse a StarTeam.ini file and work with the view and folder overrides it specifies.

Constructor Summary

DirectoryOverrides()
Create a new instance with no overrides specified.

Method Summary

boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
java.io.File	getSourceFile() Returns the source file specifying the override information.
int	hashCode() returns a unique hash for all instances of this type
void	load(java.io.File iniFile) Loads the specified ini file.
void	loadDefault() Loads the default ini file for the client platform.
void	reload() Re-loads the ini.
void	reloadIfNeeded() Re-loads the ini only if the file's last modified time stamp has changed.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryOverrides

public DirectoryOverrides()

Create a new instance with no overrides specified.

Method Detail

getSourceFile

public java.io.File getSourceFile()

Returns the source file specifying the override information.

Returns:

the source file specifying the override information.

loadDefault

public void loadDefault()
                 throws java.io.IOException

Loads the default ini file for the client platform. On Windows this is the value of the "StarTeam" environment variable which is usually "StarTeam.ini".

Throws:

java.io.IOException - if any errors occur while loading the file

load

public void load(java.io.File iniFile)
          throws java.io.IOException

Loads the specified ini file. The parsing is very loose so no errors will occur if it is not really a StarTeam.ini file.

Parameters:

iniFile - the file to load

Throws:

java.io.IOException - if any errors occur while loading the file

reload

public void reload()
            throws java.io.IOException

Re-loads the ini.

Throws:

java.io.IOException - if any errors occur while loading the file

reloadIfNeeded

public void reloadIfNeeded()
                    throws java.io.IOException

Re-loads the ini only if the file's last modified time stamp has changed.

Throws:

java.io.IOException - if any errors occur while loading the file

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