| java.lang.Object
 org.tmatesoft.svn.core.wc.SVNBasicClient
org.tmatesoft.svn.core.wc.SVNStatusClient
| SVNStatusClient | | public class SVNStatusClient extends SVNBasicClient (Code) | | The SVNStatusClient class provides methods for obtaining information on the
status of Working Copy items.
The functionality of SVNStatusClient corresponds to the 'svn status' command
of the native SVN command line client.
One of the main advantages of SVNStatusClient lies in that fact
that for each processed item the status information is collected and put into
an SVNStatus object. Further there are two ways how this object
can be passed to a developer (depending on the version of the doStatus()
method that was invoked):
- the SVNStatus can be passed to a
developer's status handler (that should implement ISVNStatusHandler)
in which the developer retrieves status information and decides how to interprete that
info;
- another way is that an appropriate doStatus() method
just returns that SVNStatus object.
Those methods that match the first variant can be called recursively - obtaining
status information for all child entries, the second variant just the reverse -
methods are called non-recursively and allow to get status info on a single
item.
version:
1.1.1
author:
TMate Software Ltd.
See Also: ISVNStatusHandler
See Also: SVNStatus
See Also: Examples |
| Method Summary | |
| public long | doStatus(File path, boolean recursive, boolean remote, boolean reportAll, boolean includeIgnored, ISVNStatusHandler handler)
Collects status information on Working Copy items and passes
it to a handler. | | public long | doStatus(File path, boolean recursive, boolean remote, boolean reportAll, boolean includeIgnored, boolean collectParentExternals, ISVNStatusHandler handler)
Collects status information on Working Copy items and passes
it to a handler. | | public long | doStatus(File path, SVNRevision revision, boolean recursive, boolean remote, boolean reportAll, boolean includeIgnored, boolean collectParentExternals, ISVNStatusHandler handler)
Collects status information on Working Copy items and passes
it to a handler. | | public SVNStatus | doStatus(File path, boolean remote)
Collects status information on a single Working Copy item. | | public SVNStatus | doStatus(File path, boolean remote, boolean collectParentExternals)
Collects status information on a single Working Copy item. |
| SVNStatusClient | | public SVNStatusClient(ISVNAuthenticationManager authManager, ISVNOptions options)(Code) | | Constructs and initializes an SVNStatusClient object
with the specified run-time configuration and authentication
drivers.
If options is null,
then this SVNStatusClient will be using a default run-time
configuration driver which takes client-side settings from the
default SVN's run-time configuration area but is not able to
change those settings (read more on
ISVNOptions and
SVNWCUtil ).
If authManager is null,
then this SVNStatusClient will be using a default authentication
and network layers driver (see
SVNWCUtil.createDefaultAuthenticationManager )
which uses server-side settings and auth storage from the
default SVN's run-time configuration area (or system properties
if that area is not found).
Parameters:
authManager - an authentication and network layers driver
Parameters:
options - a run-time configuration options driver |
| doStatus | | public long doStatus(File path, boolean recursive, boolean remote, boolean reportAll, boolean includeIgnored, ISVNStatusHandler handler) throws SVNException(Code) | | Collects status information on Working Copy items and passes
it to a handler.
Parameters:
path - local item's path
Parameters:
recursive - relevant only if path denotes a directory:true to obtain status info recursively for allchild entries, false only for items located immediatelyin the directory itself
Parameters:
remote - true to check up the status of the item in the repository,that will tell if the local item is out-of-date (like '-u' option in theSVN client's 'svn status' command), otherwise false
Parameters:
reportAll - true to collect status information on those items that are in a 'normal' state (unchanged), otherwise false
Parameters:
includeIgnored - true to force the operation to collect informationon items that were set to be ignored (like '--no-ignore' option in the SVN client's 'svn status' command to disregard default and 'svn:ignore' propertyignores), otherwise false
Parameters:
handler - a caller's status handler that will be involvedin processing status information the revision number the status information was collectedagainst
throws:
SVNException -
See Also: ISVNStatusHandler |
| doStatus | | public long doStatus(File path, boolean recursive, boolean remote, boolean reportAll, boolean includeIgnored, boolean collectParentExternals, ISVNStatusHandler handler) throws SVNException(Code) | | Collects status information on Working Copy items and passes
it to a handler.
Calling this method is equivalent to
doStatus(path, SVNRevision.HEAD, recursive, remote, reportAll, includeIgnored, collectParentExternals, handler).
Parameters:
path - local item's path
Parameters:
recursive - relevant only if path denotes a directory:true to obtain status info recursively for allchild entries, false only for items located immediately in the directory itself
Parameters:
remote - true to check up the status of the item in the repository,that will tell if the local item is out-of-date (like '-u' option in theSVN client's 'svn status' command), otherwise false
Parameters:
reportAll - true to collect status information on all items including those ones that are in a 'normal' state (unchanged), otherwise false
Parameters:
includeIgnored - true to force the operation to collect informationon items that were set to be ignored (like '--no-ignore' option in the SVN client's 'svn status' command to disregard default and 'svn:ignore' propertyignores), otherwise false
Parameters:
collectParentExternals - false to make the operation ignore informationon externals definitions (like '--ignore-externals' option in the SVNclient's 'svn status' command), otherwise true
Parameters:
handler - a caller's status handler that will be involvedin processing status information the revision number the status information was collectedagainst
throws:
SVNException - |
| doStatus | | public long doStatus(File path, SVNRevision revision, boolean recursive, boolean remote, boolean reportAll, boolean includeIgnored, boolean collectParentExternals, ISVNStatusHandler handler) throws SVNException(Code) | | Collects status information on Working Copy items and passes
it to a handler.
Parameters:
path - local item's path
Parameters:
revision - if remote is truethis revision is used to calculate status against
Parameters:
recursive - relevant only if path denotes a directory:true to obtain status info recursively for allchild entries, false only for items located immediately in the directory itself
Parameters:
remote - true to check up the status of the item in the repository,that will tell if the local item is out-of-date (like '-u' option in theSVN client's 'svn status' command), otherwise false
Parameters:
reportAll - true to collect status information on all items including those ones that are in a 'normal' state (unchanged), otherwise false
Parameters:
includeIgnored - true to force the operation to collect informationon items that were set to be ignored (like '--no-ignore' option in the SVN client's 'svn status' command to disregard default and 'svn:ignore' propertyignores), otherwise false
Parameters:
collectParentExternals - false to make the operation ignore informationon externals definitions (like '--ignore-externals' option in the SVNclient's 'svn status' command), otherwise true
Parameters:
handler - a caller's status handler that will be involvedin processing status information the revision number the status information was collectedagainst
throws:
SVNException - |
| doStatus | | public SVNStatus doStatus(File path, boolean remote) throws SVNException(Code) | | Collects status information on a single Working Copy item.
Parameters:
path - local item's path
Parameters:
remote - true to check up the status of the item in the repository,that will tell if the local item is out-of-date (like '-u' option in theSVN client's 'svn status' command), otherwise false an SVNStatus object representing status information for the item
throws:
SVNException - |
| doStatus | | public SVNStatus doStatus(File path, boolean remote, boolean collectParentExternals) throws SVNException(Code) | | Collects status information on a single Working Copy item.
Parameters:
path - local item's path
Parameters:
remote - true to check up the status of the item in the repository,that will tell if the local item is out-of-date (like '-u' option in theSVN client's 'svn status' command), otherwise false
Parameters:
collectParentExternals - false to make the operation ignore informationon externals definitions (like '--ignore-externals' option in the SVNclient's 'svn status' command), otherwise false an SVNStatus object representing status information for the item
throws:
SVNException - |
| Methods inherited from org.tmatesoft.svn.core.wc.SVNBasicClient | public void checkCancelled() throws SVNCancelException(Code)(Java Doc)
protected SVNRepository createRepository(SVNURL url, boolean mayReuse) throws SVNException(Code)(Java Doc)
protected SVNRepository createRepository(SVNURL url, File path, SVNRevision pegRevision, SVNRevision revision) throws SVNException(Code)(Java Doc)
protected SVNRepository createRepository(SVNURL url, File path, SVNRevision pegRevision, SVNRevision revision, long[] pegRev) throws SVNException(Code)(Java Doc)
protected SVNWCAccess createWCAccess()(Code)(Java Doc)
protected SVNWCAccess createWCAccess(String pathPrefix)(Code)(Java Doc)
protected void dispatchEvent(SVNEvent event) throws SVNException(Code)(Java Doc)
protected void dispatchEvent(SVNEvent event, double progress) throws SVNException(Code)(Java Doc)
public ISVNDebugLog getDebugLog()(Code)(Java Doc)
protected ISVNEventHandler getEventDispatcher()(Code)(Java Doc)
protected SVNRepositoryLocation[] getLocations(SVNURL url, File path, SVNRepository repository, SVNRevision revision, SVNRevision start, SVNRevision end) throws SVNException(Code)(Java Doc)
public ISVNOptions getOptions()(Code)(Java Doc)
protected ISVNRepositoryPool getRepositoryPool()(Code)(Java Doc)
protected long getRevisionNumber(SVNRevision revision, SVNRepository repository, File path) throws SVNException(Code)(Java Doc)
protected SVNURL getURL(File path) throws SVNException(Code)(Java Doc)
public void handleEvent(SVNEvent event, double progress) throws SVNException(Code)(Java Doc)
public boolean isIgnoreExternals()(Code)(Java Doc)
public boolean isLeaveConflictsUnresolved()(Code)(Java Doc)
public void setDebugLog(ISVNDebugLog log)(Code)(Java Doc)
public void setEventHandler(ISVNEventHandler dispatcher)(Code)(Java Doc)
public void setEventPathPrefix(String prefix)(Code)(Java Doc)
public void setIgnoreExternals(boolean ignore)(Code)(Java Doc)
public void setLeaveConflictsUnresolved(boolean leave)(Code)(Java Doc)
public void setOptions(ISVNOptions options)(Code)(Java Doc)
protected void sleepForTimeStamp()(Code)(Java Doc)
|
|
|