com.starteam
Class ClientContext.DirectoryOverrides

java.lang.Object
  com.starteam.ClientContext.DirectoryOverrides

Enclosing class:

ClientContext

public static final class ClientContext.DirectoryOverrides
extends java.lang.Object

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

Constructor Summary

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

Method Summary

java.io.File	getSourceFile() Returns the source file specifying the override information.
void	load(java.io.File iniFile) Loads the specified .xml file.
void	loadDefault() Loads the default .xml file for the client platform.
void	reload() Re-loads the .xml file.
boolean	reloadIfNeeded() Re-loads the .xml file only if the file's last modified time stamp has changed.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientContext.DirectoryOverrides

public ClientContext.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 .xml file for the client platform. On Windows this is the value of the "StarTeam" environment variable which is usually "StarTeam.xml".

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 .xml file. The parsing is very loose so no errors will occur if it is not really a StarTeam.xml 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 .xml file.

Throws:

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

reloadIfNeeded

public boolean reloadIfNeeded()
                       throws java.io.IOException

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

Returns:

true if the file was reloaded

Throws:

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