|
SVNKit Home | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.tmatesoft.svn.core.wc.SVNStatus
The SVNStatus class is used to provide detailed status information for a Working Copy item as a result of a status operation invoked by a doStatus() method of SVNStatusClient. SVNStatus objects are generated for each 'interesting' local item and depending on the doStatus() method in use either passed for notification to an ISVNStatusHandler implementation or such an object is just returned by the method as a status info for a single item.
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) { ... } ... } }
... import org.tmatesoft.svn.core.wc.SVNStatusClient; ... SVNStatusClient statusClient; ... statusClient.doStatus(...., new MyCustomStatusHandler()); ...
... 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.
ISVNStatusHandler
,
SVNStatusType
,
ExamplesConstructor Summary | |
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,
File conflictNewFile,
File conflictOldFile,
File conflictWrkFile,
File projRejectFile,
String copyFromURL,
SVNRevision copyFromRevision,
SVNLock remoteLock,
SVNLock localLock,
Map entryProperties)
Constructs an SVNStatus object filling it with status information details. |
Method Summary | |
String |
getAuthor()
Gets the author who last changed the item. |
Date |
getCommittedDate()
Gets the timestamp when the item was last changed (committed). |
SVNRevision |
getCommittedRevision()
Gets the revision when the item was last changed (committed). |
File |
getConflictNewFile()
Gets the temporary file that contains all latest changes from the repository which led to a conflict with local changes. |
File |
getConflictOldFile()
Gets the temporary BASE revision file of that working file that is currently in conflict with changes received from the repository. |
File |
getConflictWrkFile()
Gets the temporary '.mine' file with all current local changes to the original file. |
SVNStatusType |
getContentsStatus()
Gets the Working Copy local item's contents status type. |
SVNRevision |
getCopyFromRevision()
Gets the revision of the item's ancestor from which the item was copied (the item is added with history). |
String |
getCopyFromURL()
Gets the URL (repository location) of the ancestor from which the item was copied. |
org.tmatesoft.svn.core.internal.wc.admin.SVNEntry |
getEntry()
Returns a WC entry for which this object is generated. |
Map |
getEntryProperties()
Gets the item's SVN specific '<entry' properties. |
File |
getFile()
Gets the item's path in the filesystem. |
SVNNodeKind |
getKind()
Gets the item's node kind characterizing it as an entry. |
SVNLock |
getLocalLock()
Gets the file item's local lock. |
SVNStatusType |
getPropertiesStatus()
Gets the Working Copy local item's properties status type. |
File |
getPropRejectFile()
Gets the '.prej' file containing details on properties conflicts. |
String |
getRemoteAuthor()
Gets the item's last changed author. |
SVNStatusType |
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. |
Date |
getRemoteDate()
Gets the item's last changed date. |
SVNNodeKind |
getRemoteKind()
Returns the kind of the item got from the repository. |
SVNLock |
getRemoteLock()
Gets the file item's repository lock - applicable for a remote status invocation. |
SVNStatusType |
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. |
SVNRevision |
getRemoteRevision()
Gets the item's last committed repository revision. |
SVNURL |
getRemoteURL()
Gets the item's latest repository location. |
SVNRevision |
getRevision()
Gets the item's current working revision. |
SVNURL |
getURL()
Gets the item's repository location. |
Date |
getWorkingContentsDate()
Returns the last modified local time of the file item. |
Date |
getWorkingPropertiesDate()
Returns the last modified local time of file or directory properties. |
boolean |
isCopied()
Finds out if the item is added with history. |
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 |
isSwitched()
Finds out whether the item is switched to a different repository location. |
void |
markExternal()
Marks the item as an external. |
void |
setContentsStatus(SVNStatusType statusType)
Sets the item's contents status type. |
void |
setEntry(org.tmatesoft.svn.core.internal.wc.admin.SVNEntry entry)
Sets a WC entry for which this object is generated. |
void |
setRemoteStatus(SVNStatusType contents,
SVNStatusType props,
SVNLock lock,
SVNNodeKind kind)
Sets the item's remote status. |
void |
setRemoteStatus(SVNURL url,
SVNStatusType contents,
SVNStatusType props,
SVNLock lock,
SVNNodeKind kind,
SVNRevision revision,
Date date,
String author)
Sets the item's remote status. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
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, File conflictNewFile, File conflictOldFile, File conflictWrkFile, File projRejectFile, String copyFromURL, SVNRevision copyFromRevision, SVNLock remoteLock, SVNLock localLock, Map entryProperties)
Used by SVNKit internals to construct and initialize an SVNStatus object. It's not intended for users (from an API point of view).
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 URLconflictNewFile
- 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' propertiesMethod Detail |
public SVNURL getURL()
SVNProperty.URL
property.
public SVNURL getRemoteURL()
getURL()
returns the item's
URL as it's defined in a URL entry property. Applicable
for a remote status invocation.
public File getFile()
public SVNNodeKind getKind()
public SVNRevision getRevision()
public SVNRevision getCommittedRevision()
public Date getCommittedDate()
public String getAuthor()
public SVNStatusType getContentsStatus()
public SVNStatusType getPropertiesStatus()
public SVNStatusType getRemoteContentsStatus()
If the remote contents status type != SVNStatusType.STATUS_NONE
the local file may be out of date.
public SVNStatusType getRemotePropertiesStatus()
If the remote properties status type != SVNStatusType.STATUS_NONE
the local file may be out of date.
public boolean isLocked()
To clean up a Working Copy use doCleanup()
.
public boolean isCopied()
public boolean isSwitched()
public File getConflictNewFile()
public File getConflictOldFile()
public File getConflictWrkFile()
public File getPropRejectFile()
public String getCopyFromURL()
public SVNRevision getCopyFromRevision()
public SVNLock getRemoteLock()
public SVNLock getLocalLock()
public Map getEntryProperties()
SVNProperty.SVN_ENTRY_PREFIX
.
public SVNRevision getRemoteRevision()
SVNRevision.UNDEFINED
if the repository revision is
unavailablepublic SVNNodeKind getRemoteKind()
public Date getRemoteDate()
public String getRemoteAuthor()
public Date getWorkingContentsDate()
Date(0)
).
public Date getWorkingPropertiesDate()
public void markExternal()
public void setRemoteStatus(SVNStatusType contents, SVNStatusType props, SVNLock lock, SVNNodeKind kind)
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 kindpublic void setRemoteStatus(SVNURL url, SVNStatusType contents, SVNStatusType props, SVNLock lock, SVNNodeKind kind, SVNRevision revision, Date date, String author)
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 authorpublic void setContentsStatus(SVNStatusType statusType)
statusType
- status type of the item's contentspublic void setEntry(org.tmatesoft.svn.core.internal.wc.admin.SVNEntry entry)
entry
- a WC entrypublic org.tmatesoft.svn.core.internal.wc.admin.SVNEntry getEntry()
|
SVNKit Home | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |