com.starteam
Interface LocalFileSystemPropertyProvider

public interface LocalFileSystemPropertyProvider

This interface provides a mechanism for an SDK application to offer its own instance of Local File System Properties. This interface should be used with caution, if at all. All methods of this interface must be correctly implemented, since the methods on this interface override the methods of the File Object, when set

Method Summary

void	clear() Reset the state of this instance
LocalFileSystemPropertyProvider	clone(File f) Clone an instance of the implementor
boolean	getExecutable() returns True if the local file is an executable
boolean	getExists() returns True if the local file exists
File	getFile() returns the StarTeam File object associated with this instance
DateTime	getLastModified() returns the date/time that this file was last modified
long	getLength() the size of the local file
java.lang.String	getName() returns the name of the local file
java.lang.String	getPath() returns the fully qualified path to the local file
File.Status	getStatus() returns the status of this file w.r.t.
boolean	getStatusKnown() returns True if the status of this file (w.r.t.
void	setExecutable(boolean executable) Set to True if the local file is an executable
void	setExists(boolean exists) Set to True if the local file exists
void	setLastModified(DateTime lastModified) Set the date/time that the local file was modified
void	setLength(long length) Set the size of the local file
void	setName(java.lang.String name) Set the local file system name
void	setPath(java.lang.String path) Set the local file system path
void	setStatus(File.Status status) Set the status of the local file w.r.t.

Method Detail

getStatus

File.Status getStatus()

returns the status of this file w.r.t. the repository

Returns:

the status of this file w.r.t. the repository

See Also:

File.Status

getStatusKnown

boolean getStatusKnown()

returns True if the status of this file (w.r.t. the repository) is known

Returns:

True if the status of this file is known

getLength

long getLength()

the size of the local file

Returns:

the size of the local file

getLastModified

DateTime getLastModified()
                         throws java.io.IOException

returns the date/time that this file was last modified

Returns:

the date/time that this file was last modified

Throws:

java.io.IOException

getExists

boolean getExists()

returns True if the local file exists

Returns:

True if the local file exists

getName

java.lang.String getName()
                         throws java.io.IOException

returns the name of the local file

Returns:

the name of the local file

Throws:

java.io.IOException

getPath

java.lang.String getPath()
                         throws java.io.IOException

returns the fully qualified path to the local file

Returns:

the fully qualified path to the local file

Throws:

java.io.IOException

getExecutable

boolean getExecutable()
                      throws java.io.IOException

returns True if the local file is an executable

Returns:

True if the local file is an executable

Throws:

java.io.IOException

getFile

File getFile()

returns the StarTeam File object associated with this instance

Returns:

the StarTeam File object associated with this instance

setStatus

void setStatus(File.Status status)

Set the status of the local file w.r.t. its peer in the repository Note that this property is not strictly speaking, a file system property

Parameters:

status - the status of the local file w.r.t. its peer in the repository

See Also:

File.Status

setLength

void setLength(long length)

Set the size of the local file

Parameters:

length - the size of the local file

setLastModified

void setLastModified(DateTime lastModified)

Set the date/time that the local file was modified

Parameters:

lastModified - the date/time that the local file was modified

setExists

void setExists(boolean exists)

Set to True if the local file exists

Parameters:

exists - True if the local file exists

setName

void setName(java.lang.String name)

Set the local file system name

Parameters:

name - the local file system name

setPath

void setPath(java.lang.String path)

Set the local file system path

Parameters:

path - the local file system path

setExecutable

void setExecutable(boolean executable)

Set to True if the local file is an executable

Parameters:

executable - True if the local file is an executable

clear

void clear()

Reset the state of this instance

clone

LocalFileSystemPropertyProvider clone(File f)

Clone an instance of the implementor

Parameters:

f - the File in whose context the clone is created

Returns:

a cloned instance of the implementor