com.borland.primetime.teamdev.vcs
Class VCSFileStatus

java.lang.Object
  |
  +--com.borland.primetime.teamdev.vcs.VCSFileStatus

public abstract class VCSFileStatus
extends java.lang.Object

When requesting the status for a file under VCS we obtain a list of VCSFileInfo objects describing the opearations that a given VCS backend considers necessary to update the repository.

Different VCSs implement different operations and sometyimes provide different descriptions for the same operation. For example, the way CVS executes the addition of a file to a module requires a two-step process. This is, for what I know, typical of CVS.

Implementations of the VCSFileStatus interface provide a mean to describe the opeartions required by a VCS back end.


Field Summary
protected  VCSFileInfo owner
           
protected  int status
           
 
Constructor Summary
VCSFileStatus()
           
 
Method Summary
abstract  ActionGroup getActions()
          Based on the status, return a set of Actions that can performed on the file.
abstract  java.lang.String getDescription()
          This method returns a textual description for the status.
 int getStatus()
           
abstract  javax.swing.Icon getStatusIcon()
          This method returns an icon suitable to be displayed in a browser.
abstract  boolean isModifiedInVCS()
           
abstract  boolean isModifiedLocally()
           
 void setOwner(VCSFileInfo info)
           
 void setStatus(int newStatus)
          The status is assumed to be an interal int variable.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

status

protected int status

owner

protected VCSFileInfo owner
Constructor Detail

VCSFileStatus

public VCSFileStatus()
Method Detail

setStatus

public void setStatus(int newStatus)
The status is assumed to be an interal int variable.

getStatus

public int getStatus()

isModifiedLocally

public abstract boolean isModifiedLocally()

isModifiedInVCS

public abstract boolean isModifiedInVCS()

getStatusIcon

public abstract javax.swing.Icon getStatusIcon()
This method returns an icon suitable to be displayed in a browser.

getDescription

public abstract java.lang.String getDescription()
This method returns a textual description for the status.

getActions

public abstract ActionGroup getActions()
Based on the status, return a set of Actions that can performed on the file. The Action will be typically used in a context menu (right-clicking on the file name).

setOwner

public void setOwner(VCSFileInfo info)