| java.lang.Object
 org.tmatesoft.svn.core.wc.SVNStatus
| SVNStatus | | public class SVNStatus (Code) | | 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) {
if(status.getContentsStatus() == SVNStatusType.STATUS_MODIFIED) {
...
} else if(status.getContentsStatus() == SVNStatusType.STATUS_CONFLICTED) {
...
}
...
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);
...
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.
version:
1.1.1
author:
TMate Software Ltd.
See Also: ISVNStatusHandler
See Also: SVNStatusType
See Also: Examples |
| Constructor Summary | |
| 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. |
| Method Summary | |
| public String | getAuthor()
Gets the author who last changed the item. | | public Date | getCommittedDate()
Gets the timestamp when the item was last changed (committed). | | public SVNRevision | getCommittedRevision()
Gets the revision when the item was last changed (committed). | | public File | getConflictNewFile()
Gets the temporary file that contains all latest changes from the
repository which led to a conflict with local changes. | | public File | getConflictOldFile()
Gets the temporary BASE revision file of that working file that is
currently in conflict with changes received from the repository. | | public File | getConflictWrkFile()
Gets the temporary '.mine' file with all current local changes to the
original file. | | public SVNStatusType | getContentsStatus()
Gets the Working Copy local item's contents status type. | | public SVNRevision | getCopyFromRevision()
Gets the revision of the item's ancestor
from which the item was copied (the item is added
with history). | | public String | getCopyFromURL()
Gets the URL (repository location) of the ancestor from which the
item was copied. | | public SVNEntry | getEntry()
Returns a WC entry for which this object is generated. | | public Map | getEntryProperties()
Gets the item's SVN specific '<entry' properties. | | public File | getFile()
Gets the item's path in the filesystem. | | public SVNNodeKind | getKind()
Gets the item's node kind characterizing it as an entry. | | public SVNLock | getLocalLock()
Gets the file item's local lock. | | 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. | | public SVNStatusType | getPropertiesStatus()
Gets the Working Copy local item's properties status type. | | public String | getRemoteAuthor()
Gets the item's last changed author. | | 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. | | public Date | getRemoteDate()
Gets the item's last changed date. | | public SVNNodeKind | getRemoteKind()
Returns the kind of the item got from the repository. | | public SVNLock | getRemoteLock()
Gets the file item's repository lock -
applicable for a remote status invocation. | | 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. | | public SVNRevision | getRemoteRevision()
Gets the item's last committed repository revision. | | public SVNURL | getRemoteURL()
Gets the item's latest repository location. | | public SVNRevision | getRevision()
Gets the item's current working revision. | | public SVNURL | getURL()
Gets the item's repository location. | | public Date | getWorkingContentsDate()
Returns the last modified local time of the file item. | | public Date | getWorkingPropertiesDate()
Returns the last modified local time of file or directory
properties. | | public boolean | isCopied()
Finds out if the item is added with history. | | 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). | | public boolean | isSwitched()
Finds out whether the item is switched to a different
repository location. | | public void | markExternal()
Marks the item as an external. | | public void | setContentsStatus(SVNStatusType statusType)
Sets the item's contents status type. | | public void | setEntry(SVNEntry entry)
Sets a WC entry for which this object is generated. | | public void | setRemoteStatus(SVNStatusType contents, SVNStatusType props, SVNLock lock, SVNNodeKind kind)
Sets the item's remote status. | | 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. |
| 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)(Code) | | 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
Parameters:
file - item's path in a File representation
Parameters:
kind - item's node kind
Parameters:
revision - item's working revision
Parameters:
committedRevision - item's last changed revision
Parameters:
committedDate - item's last changed date
Parameters:
author - item's last commit author
Parameters:
contentsStatus - local status of item's contents
Parameters:
propertiesStatus - local status of item's properties
Parameters:
remoteContentsStatus - status of item's contents against a repository
Parameters:
remotePropertiesStatus - status of item's properties against a repository
Parameters:
isLocked - if the item is locked by the driver (not a user lock)
Parameters:
isCopied - if the item is added with history
Parameters:
isSwitched - if the item is switched to a different URL
Parameters:
conflictNewFile - temp file with latest changes from the repository
Parameters:
conflictOldFile - temp file just as the conflicting one was at the BASE revision
Parameters:
conflictWrkFile - temp file with all user's current local modifications
Parameters:
projRejectFile - temp file describing properties conflicts
Parameters:
copyFromURL - url of the item's ancestor from which the item was copied
Parameters:
copyFromRevision - item's ancestor revision from which the item was copied
Parameters:
remoteLock - item's lock in the repository
Parameters:
localLock - item's local lock
Parameters:
entryProperties - item's SVN specific '<entry' properties |
| getAuthor | | public String getAuthor()(Code) | | Gets the author who last changed the item.
the item's last commit author |
| getCommittedDate | | public Date getCommittedDate()(Code) | | Gets the timestamp when the item was last changed (committed).
the last committed date |
| getCommittedRevision | | public SVNRevision getCommittedRevision()(Code) | | Gets the revision when the item was last changed (committed).
the last committed revision |
| getConflictNewFile | | public File getConflictNewFile()(Code) | | 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.
an autogenerated temporary file just as it is in the latest revision in the repository |
| getConflictOldFile | | public File getConflictOldFile()(Code) | | 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.
an autogenerated temporary file just as the conflicting file wasbefore any modifications to it |
| getConflictWrkFile | | public File getConflictWrkFile()(Code) | | 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.
an autogenerated temporary file with only the user's modifications |
| getContentsStatus | | public SVNStatusType getContentsStatus()(Code) | | Gets the Working Copy local item's contents status type.
the local contents status type |
| getCopyFromRevision | | public SVNRevision getCopyFromRevision()(Code) | | Gets the revision of the item's ancestor
from which the item was copied (the item is added
with history).
the ancestor's revision |
| getCopyFromURL | | public String getCopyFromURL()(Code) | | Gets the URL (repository location) of the ancestor from which the
item was copied. That is when the item is added with history.
the item ancestor's URL |
| getEntry | | public SVNEntry getEntry()(Code) | | Returns a WC entry for which this object is generated.
a WC entry (if set) |
| getFile | | public File getFile()(Code) | | Gets the item's path in the filesystem.
a File representation of the item's path |
| getKind | | public SVNNodeKind getKind()(Code) | | Gets the item's node kind characterizing it as an entry.
the item's node kind (whether it's a file, directory, etc.) |
| getLocalLock | | public SVNLock getLocalLock()(Code) | | Gets the file item's local lock.
file item's local lock |
| getPropRejectFile | | public File getPropRejectFile()(Code) | | 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.
the properties conflicts file |
| getPropertiesStatus | | public SVNStatusType getPropertiesStatus()(Code) | | Gets the Working Copy local item's properties status type.
the local properties status type |
| getRemoteAuthor | | public String getRemoteAuthor()(Code) | | Gets the item's last changed author. Relevant for a
remote status invocation.
a last commit author |
| getRemoteContentsStatus | | public SVNStatusType getRemoteContentsStatus()(Code) | | 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.
the remote contents status type |
| getRemoteDate | | public Date getRemoteDate()(Code) | | Gets the item's last changed date. Relevant for a
remote status invocation.
a repository last changed date |
| getRemoteKind | | public SVNNodeKind getRemoteKind()(Code) | | Returns the kind of the item got from the repository. Relevant for a
remote status invocation.
a remote item kind |
| getRemoteLock | | public SVNLock getRemoteLock()(Code) | | Gets the file item's repository lock -
applicable for a remote status invocation.
file item's repository lock |
| getRemotePropertiesStatus | | public SVNStatusType getRemotePropertiesStatus()(Code) | | 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.
the remote properties status type |
| getRemoteRevision | | public SVNRevision getRemoteRevision()(Code) | | Gets the item's last committed repository revision. Relevant for a
remote status invocation.
the latest repository revision when the item was changed; null if there are no incomingchanges for this file or directory. |
| getRemoteURL | | public SVNURL getRemoteURL()(Code) | | Gets the item's latest repository location.
For example, the item could have been moved in the repository,
but
SVNStatus.getURL getURL() returns the item's
URL as it's defined in a URL entry property. Applicable
for a remote status invocation.
the item's URL as it's real repository location |
| getRevision | | public SVNRevision getRevision()(Code) | | Gets the item's current working revision.
the item's working revision |
| getWorkingContentsDate | | public Date getWorkingContentsDate()(Code) | | Returns the last modified local time of the file item.
Irrelevant for directories (for directories returns Date(0)).
last modified time of the file |
| getWorkingPropertiesDate | | public Date getWorkingPropertiesDate()(Code) | | Returns the last modified local time of file or directory
properties.
last modified time of the item properties |
| isCopied | | public boolean isCopied()(Code) | | Finds out if the item is added with history.
true if the itemis added with history, otherwise false |
| isLocked | | public boolean isLocked()(Code) | | 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
SVNWCClient.doCleanup(File) doCleanup() .
true if locked, otherwisefalse |
| isSwitched | | public boolean isSwitched()(Code) | | Finds out whether the item is switched to a different
repository location.
true if switched, otherwisefalse |
| markExternal | | public void markExternal()(Code) | | 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)(Code) | | 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(SVNEntry entry)(Code) | | Sets a WC entry for which this object is generated.
Used in internals.
Parameters:
entry - a WC entry |
| setRemoteStatus | | public void setRemoteStatus(SVNStatusType contents, SVNStatusType props, SVNLock lock, SVNNodeKind kind)(Code) | | 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
Parameters:
props - item's properties status type against the repository
Parameters:
lock - item's lock in the repository
Parameters:
kind - item's node kind |
| setRemoteStatus | | public void setRemoteStatus(SVNURL url, SVNStatusType contents, SVNStatusType props, SVNLock lock, SVNNodeKind kind, SVNRevision revision, Date date, String author)(Code) | | 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
Parameters:
contents - item's contents status type against the repository
Parameters:
props - item's properties status type against the repository
Parameters:
lock - item's lock in the repository
Parameters:
kind - item's node kind
Parameters:
revision - item's latest revision when it was last committed
Parameters:
date - last item's committed date
Parameters:
author - last item's committed author |
|
|