org.tmatesoft.svn.core.wc
Class SVNStatusClient
- ISVNEventHandler
public class SVNStatusClient
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.
SVNStatus | doStatus(File path, boolean remote)- Collects status information on a single Working Copy item.
|
SVNStatus | doStatus(File path, boolean remote, boolean collectParentExternals)- Collects status information on a single Working Copy item.
|
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.
|
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.
|
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.
|
checkCancelled, createRepository, createRepository, createRepository, createWCAccess, createWCAccess, dispatchEvent, dispatchEvent, getDebugLog, getEventDispatcher, getLocations, getOptions, getRepositoryPool, getRevisionNumber, getURL, handleEvent, isIgnoreExternals, isLeaveConflictsUnresolved, setDebugLog, setEventHandler, setEventPathPrefix, setIgnoreExternals, setLeaveConflictsUnresolved, sleepForTimeStamp |
SVNStatusClient
public SVNStatusClient(ISVNAuthenticationManager authManager,
ISVNOptions options) 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).
authManager - an authentication and network layers driveroptions - a run-time configuration options driver
doStatus
public SVNStatus doStatus(File path,
boolean remote)
throws SVNException Collects status information on a single Working Copy item.
path - local item's pathremote - 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 the
SVN client's 'svn status' command),
otherwise false
- an SVNStatus object representing status information
for the item
doStatus
public SVNStatus doStatus(File path,
boolean remote,
boolean collectParentExternals)
throws SVNException Collects status information on a single Working Copy item.
path - local item's pathremote - 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 the
SVN client's 'svn status' command),
otherwise falsecollectParentExternals - false to make the operation ignore information
on externals definitions (like '--ignore-externals' option in the SVN
client's 'svn status' command), otherwise false
- an SVNStatus object representing status information
for the item
doStatus
public long doStatus(File path,
boolean recursive,
boolean remote,
boolean reportAll,
boolean includeIgnored,
boolean collectParentExternals,
ISVNStatusHandler handler)
throws SVNException 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).
path - local item's pathrecursive - relevant only if path denotes a directory:
true to obtain status info recursively for all
child entries, false only for items located
immediately in the directory itselfremote - 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 the
SVN client's 'svn status' command),
otherwise falsereportAll - true to collect status information on all items including those ones that are in a
'normal' state (unchanged), otherwise falseincludeIgnored - true to force the operation to collect information
on 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' property
ignores), otherwise falsecollectParentExternals - false to make the operation ignore information
on externals definitions (like '--ignore-externals' option in the SVN
client's 'svn status' command), otherwise truehandler - a caller's status handler that will be involved
in processing status information
- the revision number the status information was collected
against
doStatus
public long doStatus(File path,
boolean recursive,
boolean remote,
boolean reportAll,
boolean includeIgnored,
ISVNStatusHandler handler)
throws SVNException Collects status information on Working Copy items and passes
it to a handler.
path - local item's pathrecursive - relevant only if path denotes a directory:
true to obtain status info recursively for all
child entries, false only for items located immediately
in the directory itselfremote - 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 the
SVN client's 'svn status' command), otherwise
falsereportAll - true to collect status information on those items that are in a
'normal' state (unchanged), otherwise falseincludeIgnored - true to force the operation to collect information
on 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' property
ignores), otherwise falsehandler - a caller's status handler that will be involved
in processing status information
- the revision number the status information was collected
against
doStatus
public long doStatus(File path,
SVNRevision revision,
boolean recursive,
boolean remote,
boolean reportAll,
boolean includeIgnored,
boolean collectParentExternals,
ISVNStatusHandler handler)
throws SVNException Collects status information on Working Copy items and passes
it to a handler.
path - local item's pathrevision - if remote is true
this revision is used to calculate status againstrecursive - relevant only if path denotes a directory:
true to obtain status info recursively for all
child entries, false only for items located
immediately in the directory itselfremote - 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 the
SVN client's 'svn status' command),
otherwise falsereportAll - true to collect status information on all items including those ones that are in a
'normal' state (unchanged), otherwise falseincludeIgnored - true to force the operation to collect information
on 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' property
ignores), otherwise falsecollectParentExternals - false to make the operation ignore information
on externals definitions (like '--ignore-externals' option in the SVN
client's 'svn status' command), otherwise truehandler - a caller's status handler that will be involved
in processing status information
- the revision number the status information was collected
against
Copyright © 2004-2006 TMate Software Ltd. All Rights Reserved.