package bluej.groupwork;

import bluej.Config;
import javafx.scene.paint.Color;

import java.io.File;




| Team status information for a file.
|
| <p>For "regular" non-distributed version control, the single status reflects both the changes
|* made locally and (potentially) any changes made in later versions in the repository.
* 
* <p>For distributed version control with non-linear history (Git), the general status indicates
| changes between the local working copy and the head of the local branch, and the "remote"
|* status indicates differences between the head of the local branch and the head of the remote
* branch. Note that the staging area is largely irrelevant.
* 
* @author Davin McCall
 
*/
public class TeamStatusInfo{
|
|private final static String prefix = "team.statusinfo.";

   
   private final static Color UPTODATE_COLOR = Color.BLACK;
   
   private final static Color CONFLICT_COLOR = Color.rgb(137,13,19);    // darker red
   private final static Color NEEDSUPDATE_COLOR = Color.rgb(11,57,120); // blue
|
|private final static Color REMOVED_COLOR = Color.rgb(135,150,170);   // grey-blue
|
|private final static Color NEEDSCOMMIT_COLOR = Color.rgb(10,85,15);  // green
|
|private final static Color DELETED_COLOR = Color.rgb(122,143,123);   // grey-green
|
|private File file;
|
|private String localVersion;
|
|private String remoteVersion;
|
|private Status status;
|
|private Status remoteStatus;
|
|/**
| A single status value for either overall/local or remote status.
|
public enum Status
   {        
      

| The file is up-to-date, the local revision is the same as in the repository
|
UP_TO_DATE("upToDate", "", "", UPTODATE_COLOR),
        
       
      
| The file doesn't exist locally, but is in the repository
|
NEEDS_CHECKOUT("needsCheckout", "", "dcvs.remote.needs.pull", NEEDSUPDATE_COLOR),
        
       
      
| The file has been deleted locally, but the deletion hasn't been committed yet
|
DELETED("deleted", "dcvs.local.deleted", "dcvs.remote.deleted", DELETED_COLOR),
        
       
      
| The repository version is newer
|
NEEDS_UPDATE("needsUpdate", "", "dcvs.remote.needs.pull", NEEDSUPDATE_COLOR),

       
      
| The local version has been modified
|
NEEDS_COMMIT("needsCommit", "dcvs.local.modified", "dcvs.remote.modified", NEEDSCOMMIT_COLOR),

       
      

| The repository version is newer, but the file is also locally modified; for local
| status, indicates merge commit is required.
|
NEEDS_MERGE("needsMerge", "needsMerge", "needsMerge"),

       
      
| The file exists locally, but not in the repository
|
NEEDS_ADD("needsAdd", "dcvs.local.new", "dcvs.remote.new", NEEDSCOMMIT_COLOR),

       
      
| The file exists locally, but has been removed in the repository
|
REMOVED("removed", "", "dcvs.remote.removed", REMOVED_COLOR),

       
      

| An unresolved conflict. This can happen when:<ul>
| <li>when two binary files have been modified maybe?
| </ul><p>
|
| The only way out is to either delete the file locally, or do a forced
| commit or a forced update.
|
UNRESOLVED("unresolved", "unresolved", "unresolved"),

       
      

| There are conflicts now present in the local file. The local file
| needs to be edited to resolve the conflicts. (This state occurs
| after an update which merged changes from the repository).
|
HAS_CONFLICTS("hasConflicts", "hasConflicts", "hasConflicts"),

       
      
| Unknown
|
WEIRD("weird", "weird", "weird"),

       
      
| It has no status, only used for default constructor while waiting for cvs
|
BLANK("", "", ""),

       
      

| The file has been created locally, but a file with the same name has been
| added in the repository. This is a conflict.
|
CONFLICT_ADD("conflictAdd", "conflictAdd", "conflictAdd"),

       
      

| Locally modified, but deleted in repository (conflict)
|
CONFLICT_LMRD("conflictLMRD", "conflictLMRD", "conflictLMRD"),

       
      

| Locally deleted, but modified in repository (conflict)
|
CONFLICT_LDRM("conflictLDRM", "conflictLDRM", "conflictLDRM"),

       
      
| The file was renamed
|
RENAMED("renamed", "renamed", "renamed"),

       
      
| File needs to be pushed to remote repository
|
NEEDS_PUSH("dcvs.needsPush", "", "dcvs.needsPush");

       
      private final String statusString;
       
      private final String dcvsStatusString;
       
      private final String dcvsRemoteStatusString;
       
      private final Color  color;

      Status(String statusString, String dcvsStatusString, String dcvsRemoteStatusString)
       {
         this(statusString, dcvsStatusString, dcvsRemoteStatusString, CONFLICT_COLOR);         
         }

      Status(String statusString, String dcvsStatusString, String dcvsRemoteStatusString, Color color)
       {            
         this.statusString = statusString;
           
         this.dcvsStatusString = dcvsStatusString;
           
         this.dcvsRemoteStatusString = dcvsRemoteStatusString;
           
         this.color = color;         
         }

       
      public String getStatusString()
       {
         return statusString.isEmpty() ? "" : Config.getString(prefix + statusString);         
         }

       
      public String getDCVSStatusString(boolean remote)
       {
         String label = (remote) ? dcvsRemoteStatusString : dcvsStatusString;
         return label.isEmpty() ? "" : Config.getString(prefix + label);         
         }

       
      


| Get the colour for the given status ID value
|
public Color getStatusColour()
       {            
         return color;         
         }     
      }
    
   
   


| Default "blank" status info. Used to pre-populate status table whilst 
|* awaiting repository response.
   */
   
   public TeamStatusInfo()
   {        
      this(new File(""), "", "", Status.BLANK, Status.BLANK);     
      }

   
   /**
   * constructor used with DVCS.
   *
   * @param file file in the local file system.
   * @param localVersion file version in the local repository.
| @param remoteVersion file version in the remote server.
| @param status file status in the local repository.
| @param remoteStatus file status in the remote server.
|
public TeamStatusInfo(File file, String localVersion, String remoteVersion, Status status, Status remoteStatus)
   {
      this(file, localVersion, remoteVersion, status);
       
      this.remoteStatus = remoteStatus;     
      }
    
   
   


| Constructor for TeamStatusInfo.
|
public TeamStatusInfo(File file, String localVersion, String remoteVersion, Status status)
   {        
      this.file = file;
       
      this.localVersion = localVersion;
       
      this.remoteVersion = remoteVersion;
       
      this.status = status;
       
      this.remoteStatus = Status.UP_TO_DATE;     
      }

   
   


| Returns either the local status of the file or the remote one, based on the invoker selection.
|
| @param local A flag to select which status is needed
| @return The local or remote status of the file
|
public Status getStatus(boolean local)
   {        
      return local ? status : remoteStatus;     
      }
    
   
   public File getFile()
   {        
      return file;     
      }
    
   
   public String getLocalVersion()
   {        
      return localVersion;     
      }
    
   
   public String getRepositoryVersion()
   {        
      return remoteVersion;     
      }
    
   
   public Status getStatus()
   {        
      return status;     
      }
    
   
   public void setStatus(Status s)
   {        
      status = s;     
      }
    
   
   public Status getRemoteStatus()
   {        
      return remoteStatus;     
      }

   
   public void setRemoteStatus(Status remoteStatus)
   {        
      this.remoteStatus = remoteStatus;     
      }
    
   
   @Override
   
   public String toString()
   {
      return getFile().getName();     
      } 
   }