org.tmatesoft.svn.core.wc

Class SVNStatus

java.lang.Object
- org.tmatesoft.svn.core.wc.SVNStatus

public class SVNStatus

extends Object

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) {
             ...
         }
         ...
     }
 }

...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.

1.1.1

Author:: TMate Software Ltd.

See Also:: ISVNStatusHandler, SVNStatusType, Examples

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.
`File`	`getPropRejectFile()` Gets the '.prej' file containing details on properties conflicts.
`SVNStatusType`	`getPropertiesStatus()` Gets the Working Copy local item's properties status type.
`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(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.

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,
                 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.
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 location
file - item's path in a File representation
kind - item's node kind
revision - item's working revision
committedRevision - item's last changed revision
committedDate - item's last changed date
author - item's last commit author
contentsStatus - local status of item's contents
propertiesStatus - local status of item's properties
remoteContentsStatus - status of item's contents against a repository
remotePropertiesStatus - status of item's properties against a repository
isLocked - if the item is locked by the driver (not a user lock)
isCopied - if the item is added with history
isSwitched - if the item is switched to a different URL
conflictNewFile - temp file with latest changes from the repository
conflictOldFile - temp file just as the conflicting one was at the BASE revision
conflictWrkFile - temp file with all user's current local modifications
projRejectFile - temp file describing properties conflicts
copyFromURL - url of the item's ancestor from which the item was copied
copyFromRevision - item's ancestor revision from which the item was copied
remoteLock - item's lock in the repository
localLock - item's local lock
entryProperties - item's SVN specific '<entry' properties

getAuthor

public String getAuthor()

Gets the author who last changed the item.
Returns:
the item's last commit author

getCommittedDate

public Date getCommittedDate()

Gets the timestamp when the item was last changed (committed).
Returns:
the last committed date

getCommittedRevision

public SVNRevision getCommittedRevision()

Gets the revision when the item was last changed (committed).
Returns:
the last committed revision

getConflictNewFile

public File 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

public File 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

public File 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

getContentsStatus

public SVNStatusType getContentsStatus()

Gets the Working Copy local item's contents status type.
Returns:
the local contents status type

getCopyFromRevision

public SVNRevision 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

getCopyFromURL

public String 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

getEntry

public org.tmatesoft.svn.core.internal.wc.admin.SVNEntry getEntry()

Returns a WC entry for which this object is generated.
Returns:
a WC entry (if set)

getEntryProperties

public Map getEntryProperties()

Gets the item's SVN specific '<entry' properties. These properties' names start with SVNProperty.SVN_ENTRY_PREFIX.
Returns:
a Map which keys are names of SVN entry properties mapped against their values (both strings)

getFile

public File getFile()

Gets the item's path in the filesystem.
Returns:
a File representation of the item's path

getKind

public SVNNodeKind 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.)

getLocalLock

public SVNLock getLocalLock()

Gets the file item's local lock.
Returns:
file item's local lock

getPropRejectFile

public File 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

getPropertiesStatus

public SVNStatusType getPropertiesStatus()

Gets the Working Copy local item's properties status type.
Returns:
the local properties status type

getRemoteAuthor

public String getRemoteAuthor()

Gets the item's last changed author. Relevant for a remote status invocation.
Returns:
a last commit author

getRemoteContentsStatus

public 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. 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

getRemoteDate

public Date getRemoteDate()

Gets the item's last changed date. Relevant for a remote status invocation.
Returns:
a repository last changed date

getRemoteKind

public SVNNodeKind getRemoteKind()

Returns the kind of the item got from the repository. Relevant for a remote status invocation.
Returns:
a remote item kind

getRemoteLock

public SVNLock getRemoteLock()

Gets the file item's repository lock - applicable for a remote status invocation.
Returns:
file item's repository lock

getRemotePropertiesStatus

public 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. 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

getRemoteRevision

public SVNRevision 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; null or SVNRevision.UNDEFINED if the repository revision is unavailable

getRemoteURL

public SVNURL getRemoteURL()

Gets the item's latest repository location. For example, the item could have been moved in the repository, but getURL() returns the item's URL as it's defined in a URL entry property. Applicable for a remote status invocation.
Returns:
the item's URL as it's real repository location

getRevision

public SVNRevision getRevision()

Gets the item's current working revision.
Returns:
the item's working revision

getURL

public SVNURL getURL()

Gets the item's repository location. URL is taken from the SVNProperty.URL property.
Returns:
the item's URL represented as an SVNURL object

getWorkingContentsDate

public Date getWorkingContentsDate()

Returns the last modified local time of the file item. Irrelevant for directories (for directories returns Date(0)).
Returns:
last modified time of the file

getWorkingPropertiesDate

public Date getWorkingPropertiesDate()

Returns the last modified local time of file or directory properties.
Returns:
last modified time of the item properties

isCopied

public boolean isCopied()

Finds out if the item is added with history.
Returns:
true if the item is added with history, otherwise false

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

isSwitched

public boolean isSwitched()

Finds out whether the item is switched to a different repository location.
Returns:
true if switched, otherwise false

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).

setContentsStatus

public void setContentsStatus(SVNStatusType statusType)

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

public void setEntry(org.tmatesoft.svn.core.internal.wc.admin.SVNEntry entry)

Sets a WC entry for which this object is generated. Used in internals.
Parameters:
entry - a WC entry

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 URL
contents - item's contents status type against the repository
props - item's properties status type against the repository
lock - item's lock in the repository
kind - item's node kind
revision - item's latest revision when it was last committed
date - last item's committed date
author - last item's committed author

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 repository
props - item's properties status type against the repository
lock - item's lock in the repository
kind - item's node kind

Overview Package Tree Index Deprecated About	SVNKit Home
Prev Class \| Next Class	SVNKit Home	Frames \| No Frames
Summary: Nested \| Field \| Method \| Constr	Detail: Nested \| Field \| Method \| Constr

org.tmatesoft.svn.core.wc

Class SVNStatus

Constructor Summary

Method Summary

Constructor Details

SVNStatus

Method Details

getAuthor

getCommittedDate

getCommittedRevision

getConflictNewFile

getConflictOldFile

getConflictWrkFile

getContentsStatus

getCopyFromRevision

getCopyFromURL

getEntry

getEntryProperties

getFile

getKind

getLocalLock

getPropRejectFile

getPropertiesStatus

getRemoteAuthor

getRemoteContentsStatus

getRemoteDate

getRemoteKind

getRemoteLock

getRemotePropertiesStatus

getRemoteRevision

getRemoteURL

getRevision

getURL

getWorkingContentsDate

getWorkingPropertiesDate

isCopied

isLocked

isSwitched

markExternal

setContentsStatus

setEntry

setRemoteStatus

setRemoteStatus