Class SVNStatus
Within the status handler implementation a developer decides how to interpret status information. For some purposes this way may be more flexible in comparison with calling doStatus() that returns an SVNStatus per one local item. However the latter one may be useful when needing to find out the status of the concrete item.
There are two approaches how to process SVNStatus objects:
1. Implementing an ISVNStatusHandler:
import org.tmatesoft.svn.core.wc.ISVNStatusHandler; import org.tmatesoft.svn.core.wc.SVNStatus; import org.tmatesoft.svn.core.wc.SVNStatusType; ... public class MyCustomStatusHandler implements ISVNStatusHandler { public void handleStatus(SVNStatus status) { //parse the item's contents status if(status.getContentsStatus() == SVNStatusType.STATUS_MODIFIED) { ... } else if(status.getContentsStatus() == SVNStatusType.STATUS_CONFLICTED) { ... } ... //parse properties status if(status.getPropertiesStatus() == SVNStatusType.STATUS_MODIFIED) { ... } ... } }
...and providing a status handler implementation to an SVNStatusClient's doStatus() method:
... import org.tmatesoft.svn.core.wc.SVNStatusClient; ... SVNStatusClient statusClient; ... statusClient.doStatus(...., new MyCustomStatusHandler()); ...
2. Or process an SVNStatus like this:
... SVNStatus status = statusClient.doStatus(new File(myPath), false); //parsing status info here ...
SVNStatus's methods which names start with getRemote
are
relevant for remote status invocations - that is when a doStatus() method of
SVNStatusClient is called with the flag remote
set to
true.
- Since:
- 1.2
- Version:
- 1.3
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
private String
private Date
private SVNRevision
private File
private File
private File
private SVNStatusType
private SVNRevision
private String
private SVNDepth
private SVNEntry
private Map
private File
private boolean
private boolean
private boolean
private boolean
private boolean
private boolean
private SVNNodeKind
private Date
private SVNLock
private Date
private File
private File
private SVNStatusType
private SVNStatusType
private File
private String
private SVNStatusType
private Date
private SVNNodeKind
private SVNLock
private SVNStatusType
private SVNStatusType
private SVNRevision
private SVNURL
private String
private SVNURL
private String
private SVNRevision
private SVNTreeConflictDescription
private SVNURL
private int
-
Constructor Summary
ConstructorsConstructorDescriptionSVNStatus
(SVNURL url, File file, SVNNodeKind kind, SVNRevision revision, SVNRevision committedRevision, Date committedDate, String author, SVNStatusType contentsStatus, SVNStatusType propertiesStatus, SVNStatusType remoteContentsStatus, SVNStatusType remotePropertiesStatus, boolean isLocked, boolean isCopied, boolean isSwitched, boolean isFileExternal, File conflictNewFile, File conflictOldFile, File conflictWrkFile, File projRejectFile, String copyFromURL, SVNRevision copyFromRevision, SVNLock remoteLock, SVNLock localLock, Map entryProperties, String changelistName, int wcFormatVersion, SVNTreeConflictDescription treeConflict) Constructs an SVNStatus object filling it with status information details. -
Method Summary
Modifier and TypeMethodDescriptionstatic SVNStatusType
combineNodeAndContentsStatus
(int workingCopyFormat, SVNStatusType nodeStatus, SVNStatusType contentsStatus, boolean versioned, boolean conflicted) static SVNStatusType
combineRemoteNodeAndContentsStatus
(int workingCopyFormat, SVNStatusType remoteNodeStatus, SVNStatusType remoteContentsStatus) Gets the author who last changed the item.Returns the name of the changelist which the working copy item, denoted by this object, belongs to.Gets the timestamp when the item was last changed (committed).Gets the revision when the item was last changed (committed).Gets the temporary file that contains all latest changes from the repository which led to a conflict with local changes.Gets the temporary BASE revision file of that working file that is currently in conflict with changes received from the repository.Gets the temporary '.mine' file with all current local changes to the original file.Gets the Working Copy local item's contents status type.Gets the revision of the item's ancestor from which the item was copied (the item is added with history).Gets the URL (repository location) of the ancestor from which the item was copied.getDepth()
getEntry()
Returns a WC entry for which this object is generated.Gets the item's SVN specific '<entry' properties.getFile()
Gets the item's path in the filesystem.getKind()
Gets the item's node kind characterizing it as an entry.Gets the file item's local lock.Gets the Working Copy local item's properties status type.Gets the '.prej' file containing details on properties conflicts.Gets the item's last changed author.Gets the Working Copy item's contents status type against the repository - that is comparing the item's BASE revision and the latest one in the repository when the item was changed.Gets the item's last changed date.Returns the kind of the item got from the repository.Gets the file item's repository lock - applicable for a remote status invocation.Gets the Working Copy item's properties status type against the repository - that is comparing the item's BASE revision and the latest one in the repository when the item was changed.Gets the item's last committed repository revision.Gets the item's latest repository location.Gets the item's current working revision.Returns a tree conflict description.getURL()
Gets the item's repository location.Returns the last modified local time of the file item.int
Returns the working copy format number for the admin directory which the statused item is versioned under.Returns the last modified local time of file or directory properties.boolean
boolean
isCopied()
Finds out if the item is added with history.boolean
Tells if this is an externals file or not.boolean
isLocked()
Finds out if the item is locked (not a user lock but a driver's one when during an operation a Working Copy is locked in .svn administrative areas to prevent from other operations interrupting until the running one finishes).boolean
Finds out whether the item is switched to a different repository location.boolean
void
Marks the item as an external.void
void
setChangelistName
(String changelistName) void
setCommittedDate
(Date committedDate) void
setCommittedRevision
(SVNRevision committedRevision) void
setConflicted
(boolean isConflicted) void
setConflictNewFile
(File conflictNewFile) void
setConflictOldFile
(File conflictOldFile) void
setConflictWrkFile
(File conflictWrkFile) void
setContentsStatus
(SVNStatusType statusType) Sets the item's contents status type.void
setCopyFromRevision
(SVNRevision copyFromRevision) void
setCopyFromURL
(String copyFromURL) void
void
Sets a WC entry for which this object is generated.void
setEntryProperties
(Map entryProperties) void
void
setIsConflicted
(boolean isConflicted) void
setIsCopied
(boolean isCopied) void
setIsFileExternal
(boolean isFileExternal) void
setIsLocked
(boolean isLocked) void
setIsSwitched
(boolean isSwitched) void
setIsVersioned
(boolean isVersioned) void
setKind
(SVNNodeKind kind) void
setLocalContentsDate
(Date localContentsDate) void
setLocalLock
(SVNLock localLock) void
setLocalPropertiesDate
(Date localPropertiesDate) void
setMovedFromPath
(File path) void
setMovedToPath
(File path) void
setNodeStatus
(SVNStatusType nodeStatus) void
setPropertiesStatus
(SVNStatusType propertiesStatus) void
setPropRejectFile
(File propRejectFile) void
setRemoteAuthor
(String remoteAuthor) void
setRemoteContentsStatus
(SVNStatusType remoteContentsStatus) void
setRemoteDate
(Date remoteDate) void
setRemoteKind
(SVNNodeKind remoteKind) void
setRemoteLock
(SVNLock remoteLock) void
setRemoteNodeStatus
(SVNStatusType remoteNodeStatus) void
setRemotePropertiesStatus
(SVNStatusType remotePropertiesStatus) void
setRemoteRevision
(SVNRevision remoteRevision) void
setRemoteStatus
(SVNURL url, SVNStatusType contents, SVNStatusType props, SVNLock lock, SVNNodeKind kind, SVNRevision revision, Date date, String author) Sets the item's remote status.void
setRemoteStatus
(SVNStatusType contents, SVNStatusType props, SVNLock lock, SVNNodeKind kind) Sets the item's remote status.void
setRemoteURL
(SVNURL remoteURL) void
setRepositoryRelativePath
(String repositoryRelativePath) void
setRepositoryRootURL
(SVNURL repositoryRootURL) void
setRepositoryUUID
(String repositoryUUID) void
setRevision
(SVNRevision revision) void
setTreeConflict
(SVNTreeConflictDescription treeConflict) void
void
setWorkingCopyFormat
(int workingCopyFormat)
-
Field Details
-
myURL
-
myFile
-
myKind
-
myRevision
-
myCommittedRevision
-
myCommittedDate
-
myAuthor
-
myContentsStatus
-
myPropertiesStatus
-
myRemoteContentsStatus
-
myRemoteNodeStatus
-
myRemotePropertiesStatus
-
myIsLocked
private boolean myIsLocked -
myIsCopied
private boolean myIsCopied -
myIsSwitched
private boolean myIsSwitched -
myIsFileExternal
private boolean myIsFileExternal -
myConflictNewFile
-
myConflictOldFile
-
myConflictWrkFile
-
myPropRejectFile
-
myCopyFromURL
-
myCopyFromRevision
-
myRemoteLock
-
myLocalLock
-
myEntryProperties
-
myRemoteRevision
-
myRemoteURL
-
myRemoteKind
-
myRemoteAuthor
-
myRemoteDate
-
myLocalContentsDate
-
myLocalPropertiesDate
-
myEntry
-
myChangelistName
-
myWorkingCopyFormat
private int myWorkingCopyFormat -
myTreeConflict
-
myIsConflicted
private boolean myIsConflicted -
myNodeStatus
-
myRepositoryRootURL
-
myRepositoryUUID
-
myRepositoryRelativePath
-
myIsVersioned
private boolean myIsVersioned -
myDepth
-
myMovedToPath
-
myMovedFromPath
-
-
Constructor Details
-
SVNStatus
public SVNStatus(SVNURL url, File file, SVNNodeKind kind, SVNRevision revision, SVNRevision committedRevision, Date committedDate, String author, SVNStatusType contentsStatus, SVNStatusType propertiesStatus, SVNStatusType remoteContentsStatus, SVNStatusType remotePropertiesStatus, boolean isLocked, boolean isCopied, boolean isSwitched, boolean isFileExternal, File conflictNewFile, File conflictOldFile, File conflictWrkFile, File projRejectFile, String copyFromURL, SVNRevision copyFromRevision, SVNLock remoteLock, SVNLock localLock, Map entryProperties, String changelistName, int wcFormatVersion, SVNTreeConflictDescription treeConflict) Constructs an SVNStatus object filling it with status information details.Used by SVNKit internals to construct and initialize an SVNStatus object. It's not intended for users (from an API point of view).
- Parameters:
url
- item's repository locationfile
- item's path in a File representationkind
- item's node kindrevision
- item's working revisioncommittedRevision
- item's last changed revisioncommittedDate
- item's last changed dateauthor
- item's last commit authorcontentsStatus
- local status of item's contentspropertiesStatus
- local status of item's propertiesremoteContentsStatus
- status of item's contents against a repositoryremotePropertiesStatus
- status of item's properties against a repositoryisLocked
- if the item is locked by the driver (not a user lock)isCopied
- if the item is added with historyisSwitched
- if the item is switched to a different URLisFileExternal
- tells if the item is an external fileconflictNewFile
- temp file with latest changes from the repositoryconflictOldFile
- temp file just as the conflicting one was at the BASE revisionconflictWrkFile
- temp file with all user's current local modificationsprojRejectFile
- temp file describing properties conflictscopyFromURL
- url of the item's ancestor from which the item was copiedcopyFromRevision
- item's ancestor revision from which the item was copiedremoteLock
- item's lock in the repositorylocalLock
- item's local lockentryProperties
- item's SVN specific '<entry' propertieschangelistName
- changelist name which the item belongs towcFormatVersion
- working copy format numbertreeConflict
- tree conflict description- Since:
- 1.3
-
SVNStatus
public SVNStatus()
-
-
Method Details
-
getURL
Gets the item's repository location. URL is taken from theSVNProperty.URL
property.- Returns:
- the item's URL represented as an SVNURL object
-
getRemoteURL
Gets the item's latest repository location. For example, the item could have been moved in the repository, butgetURL()
returns the item's URL as it's defined in a URL entry property. Applicable for a remote status invocation. Used by SVNKit internals and not intended for users (from an API point of view). UsegetRepositoryRelativePath
andgetRepositoryRootURL()
instead.- Returns:
- the item's URL as it's real repository location
-
getFile
Gets the item's path in the filesystem.- Returns:
- a File representation of the item's path
-
getKind
Gets the item's node kind characterizing it as an entry.- Returns:
- the item's node kind (whether it's a file, directory, etc.)
-
getRevision
Gets the item's current working revision.- Returns:
- the item's working revision
-
getCommittedRevision
Gets the revision when the item was last changed (committed).- Returns:
- the last committed revision
-
getCommittedDate
Gets the timestamp when the item was last changed (committed).- Returns:
- the last committed date
-
getAuthor
Gets the author who last changed the item.- Returns:
- the item's last commit author
-
getContentsStatus
Gets the Working Copy local item's contents status type.- Returns:
- the local contents status type
-
getPropertiesStatus
Gets the Working Copy local item's properties status type.- Returns:
- the local properties status type
-
getRemoteContentsStatus
Gets the Working Copy item's contents status type against the repository - that is comparing the item's BASE revision and the latest one in the repository when the item was changed. Applicable for a remote status invocation.If the remote contents status type !=
SVNStatusType.STATUS_NONE
the local file may be out of date.- Returns:
- the remote contents status type
-
getRemotePropertiesStatus
Gets the Working Copy item's properties status type against the repository - that is comparing the item's BASE revision and the latest one in the repository when the item was changed. Applicable for a remote status invocation.If the remote properties status type !=
SVNStatusType.STATUS_NONE
the local file may be out of date.- Returns:
- the remote properties status type
-
isLocked
public boolean isLocked()Finds out if the item is locked (not a user lock but a driver's one when during an operation a Working Copy is locked in .svn administrative areas to prevent from other operations interrupting until the running one finishes).To clean up a Working Copy use
doCleanup()
.- Returns:
- true if locked, otherwise false
-
isCopied
public boolean isCopied()Finds out if the item is added with history.- Returns:
- true if the item is added with history, otherwise false
-
isSwitched
public boolean isSwitched()Finds out whether the item is switched to a different repository location.- Returns:
- true if switched, otherwise false
-
isFileExternal
public boolean isFileExternal()Tells if this is an externals file or not.- Returns:
- true if is a file external, otherwise false
- Since:
- 1.3
-
getConflictNewFile
Gets the temporary file that contains all latest changes from the repository which led to a conflict with local changes. This file is at the HEAD revision.- Returns:
- an autogenerated temporary file just as it is in the latest revision in the repository
-
getConflictOldFile
Gets the temporary BASE revision file of that working file that is currently in conflict with changes received from the repository. This file does not contain the latest user's modifications, only 'pristine' contents.- Returns:
- an autogenerated temporary file just as the conflicting file was before any modifications to it
-
getConflictWrkFile
Gets the temporary '.mine' file with all current local changes to the original file. That is if the file item is in conflict with changes that came during an update this temporary file is created to get the snapshot of the user's file with only the user's local modifications and nothing more.- Returns:
- an autogenerated temporary file with only the user's modifications
-
getPropRejectFile
Gets the '.prej' file containing details on properties conflicts. If the item's properties are in conflict with those that came during an update this file will contain a conflict description.- Returns:
- the properties conflicts file
-
getCopyFromURL
Gets the URL (repository location) of the ancestor from which the item was copied. That is when the item is added with history.- Returns:
- the item ancestor's URL
-
getCopyFromRevision
Gets the revision of the item's ancestor from which the item was copied (the item is added with history).- Returns:
- the ancestor's revision
-
getRemoteLock
Gets the file item's repository lock - applicable for a remote status invocation.- Returns:
- file item's repository lock
-
getLocalLock
Gets the file item's local lock.- Returns:
- file item's local lock
-
getEntryProperties
Gets the item's SVN specific '<entry' properties. These properties' names start withSVNProperty.SVN_ENTRY_PREFIX
.- Returns:
- a Map which keys are names of SVN entry properties mapped against their values (both strings)
-
getRemoteRevision
Gets the item's last committed repository revision. Relevant for a remote status invocation.- Returns:
- the latest repository revision when the item was changed; SVNRevision.UNDEFINED if there are no incoming changes for this file or directory.
-
getRemoteKind
Returns the kind of the item got from the repository. Relevant for a remote status invocation.- Returns:
- a remote item kind
-
getRemoteDate
Gets the item's last changed date. Relevant for a remote status invocation.- Returns:
- a repository last changed date
-
getRemoteAuthor
Gets the item's last changed author. Relevant for a remote status invocation.- Returns:
- a last commit author
-
getWorkingContentsDate
Returns the last modified local time of the file item. Irrelevant for directories (for directories returnsDate(0)
).- Returns:
- last modified time of the file
-
getWorkingPropertiesDate
Returns the last modified local time of file or directory properties.- Returns:
- last modified time of the item properties
-
markExternal
public void markExternal()Marks the item as an external. This method is used by SVNKit internals and not intended for users (from an API point of view). -
setRemoteStatus
public void setRemoteStatus(SVNStatusType contents, SVNStatusType props, SVNLock lock, SVNNodeKind kind) Sets the item's remote status. Used by SVNKit internals and not intended for users (from an API point of view).- Parameters:
contents
- item's contents status type against the repositoryprops
- item's properties status type against the repositorylock
- item's lock in the repositorykind
- item's node kind
-
setRemoteStatus
public void setRemoteStatus(SVNURL url, SVNStatusType contents, SVNStatusType props, SVNLock lock, SVNNodeKind kind, SVNRevision revision, Date date, String author) Sets the item's remote status. Used by SVNKit internals and not intended for users (from an API point of view).- Parameters:
url
- item's repository URLcontents
- item's contents status type against the repositoryprops
- item's properties status type against the repositorylock
- item's lock in the repositorykind
- item's node kindrevision
- item's latest revision when it was last committeddate
- last item's committed dateauthor
- last item's committed author
-
setContentsStatus
Sets the item's contents status type. Used by SVNKit internals and not intended for users (from an API point of view).- Parameters:
statusType
- status type of the item's contents
-
setEntry
Sets a WC entry for which this object is generated. Used in internals.- Parameters:
entry
- a WC entry
-
getEntry
Returns a WC entry for which this object is generated.- Returns:
- a WC entry (if set)
-
getChangelistName
Returns the name of the changelist which the working copy item, denoted by this object, belongs to.- Returns:
- changelist name
- Since:
- 1.2
-
getTreeConflict
Returns a tree conflict description.- Returns:
- tree conflict description;
null
if no conflict description exists on this item - Since:
- 1.3
-
getWorkingCopyFormat
public int getWorkingCopyFormat()Returns the working copy format number for the admin directory which the statused item is versioned under. If this status object is a result of a remote status operation, the method will return-1
.- Returns:
- working copy format number;
-1
for remote status - Since:
- 1.2
-
setConflicted
public void setConflicted(boolean isConflicted) -
isConflicted
public boolean isConflicted() -
isVersioned
public boolean isVersioned() -
getRemoteNodeStatus
-
getCombinedNodeAndContentsStatus
-
getCombinedRemoteNodeAndContentsStatus
-
getNodeStatus
-
getRepositoryRootURL
-
getRepositoryUUID
-
getRepositoryRelativePath
-
getDepth
-
getMovedToPath
-
getMovedFromPath
-
setRemoteNodeStatus
-
setNodeStatus
-
setRepositoryRootURL
-
setRepositoryUUID
-
setRepositoryRelativePath
-
setURL
-
setFile
-
setKind
-
setRevision
-
setCommittedRevision
-
setCommittedDate
-
setAuthor
-
setPropertiesStatus
-
setRemoteContentsStatus
-
setRemotePropertiesStatus
-
setIsLocked
public void setIsLocked(boolean isLocked) -
setIsCopied
public void setIsCopied(boolean isCopied) -
setIsSwitched
public void setIsSwitched(boolean isSwitched) -
setIsFileExternal
public void setIsFileExternal(boolean isFileExternal) -
setConflictNewFile
-
setConflictOldFile
-
setConflictWrkFile
-
setPropRejectFile
-
setCopyFromURL
-
setCopyFromRevision
-
setRemoteLock
-
setLocalLock
-
setEntryProperties
-
setRemoteRevision
-
setRemoteURL
-
setRemoteKind
-
setRemoteAuthor
-
setRemoteDate
-
setLocalContentsDate
-
setLocalPropertiesDate
-
setChangelistName
-
setWorkingCopyFormat
public void setWorkingCopyFormat(int workingCopyFormat) -
setTreeConflict
-
setIsConflicted
public void setIsConflicted(boolean isConflicted) -
setIsVersioned
public void setIsVersioned(boolean isVersioned) -
setDepth
-
setMovedFromPath
-
setMovedToPath
-
combineNodeAndContentsStatus
public static SVNStatusType combineNodeAndContentsStatus(int workingCopyFormat, SVNStatusType nodeStatus, SVNStatusType contentsStatus, boolean versioned, boolean conflicted) -
combineRemoteNodeAndContentsStatus
public static SVNStatusType combineRemoteNodeAndContentsStatus(int workingCopyFormat, SVNStatusType remoteNodeStatus, SVNStatusType remoteContentsStatus)
-