public class SynchronizationInfo extends Object implements Serializable
state
of the
file. Does it exist in the workspace or in the repository? Does it exist in both places? Was the worksapce file synchronized
with the repository file at some point? If so, which version of the repository file? Is the file still in sync with
the repository file or has the repository file changed? Or has the workspace file changed?
All of these questions can be answered with these details. It provides information about the state of the file in the workspace (if it exists). It provides information about the state of the file in the repository (if it exists). It provides information about the synchronization state between the workspace and the repository to tell the user whether the file has been retrieved from the repository. It also provides detailed information about the state of the files in case they are out-of-sync, details are provided to determine whether the file in the workspace has changed or whether the file in the repository has changed, or both.
With this information, end users can determine the workspace files are out-of-sync with the repository file and decide whether the user should pull changes from the repository into the workspace or push changes from the workspace into the repository. Or the user could decide to do nothing at all and to continue working with the file contents as is.
Modifier and Type | Class and Description |
---|---|
static class |
SynchronizationInfo.CheckoutStatus
Enumeration that describes the
checkin status of the file. |
static class |
SynchronizationInfo.FileStatus
Enumeration that describes where the file exists.
|
static class |
SynchronizationInfo.SynchronizationStatus
Enumeration that describes whether the file has been synchronized between the workspace and repository.
|
Constructor and Description |
---|
SynchronizationInfo(String path,
RepositoryFileInfo repositoryFileInfo,
SynchronizationFileInfo synchronizationFileInfo,
WorkspaceFileInfo workspaceFileInfo,
SynchronizationInfo.FileStatus fileStatus,
SynchronizationInfo.SynchronizationStatus synchronizationStatus,
SynchronizationInfo.CheckoutStatus checkoutStatus)
Initializing constructor that sets the values of all variables.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
SynchronizationInfo.CheckoutStatus |
getCheckoutStatus()
Gets the checkout status of the file.
|
SynchronizationInfo.FileStatus |
getFileStatus()
Gets the location of the file.
|
String |
getPath()
Gets the file path that is associated with the synchronization information.
|
RepositoryFileInfo |
getRepositoryFileInfo()
Gets the repository file information, if the file exists in the repository.
|
SynchronizationFileInfo |
getSynchronizationFileInfo()
Gets the synchronization file information, if the file was synchronized between the workspace and repository.
|
SynchronizationInfo.SynchronizationStatus |
getSynchronizationStatus()
Gets the synchronization status between the repository and workspace files.
|
WorkspaceFileInfo |
getWorkspaceFileInfo()
Gets the workspace file information, if the file exists in the workspace.
|
int |
hashCode() |
String |
toString() |
public SynchronizationInfo(String path, RepositoryFileInfo repositoryFileInfo, SynchronizationFileInfo synchronizationFileInfo, WorkspaceFileInfo workspaceFileInfo, SynchronizationInfo.FileStatus fileStatus, SynchronizationInfo.SynchronizationStatus synchronizationStatus, SynchronizationInfo.CheckoutStatus checkoutStatus)
It is not intended or recommended that the consumer of the API construct these objects.
path
- the full path of the file.repositoryFileInfo
- the repository file information if the file exists in the repository.synchronizationFileInfo
- the synchronization details for the file.workspaceFileInfo
- the workspace file information, if the file exists in the workspace.fileStatus
- where the file exists.synchronizationStatus
- the synchronization status for the file.checkoutStatus
- the checkout status for the file.public String getPath()
public RepositoryFileInfo getRepositoryFileInfo()
null
.null
.public SynchronizationFileInfo getSynchronizationFileInfo()
null
.null
.public WorkspaceFileInfo getWorkspaceFileInfo()
null
.null
.public SynchronizationInfo.FileStatus getFileStatus()
public SynchronizationInfo.SynchronizationStatus getSynchronizationStatus()
public SynchronizationInfo.CheckoutStatus getCheckoutStatus()
Copyright (c) 2020, SAS Institute Inc., Cary, NC, USA