org.tmatesoft.svn.core.wc
public class SVNStatusClient extends SVNBasicClient
'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):
ISVNStatusHandler
,
SVNStatus
,
ExamplesSVNBasicClient.RepositoryReference, SVNBasicClient.SVNRepositoryLocation
UNKNOWN
NULL
Constructor and Description |
---|
SVNStatusClient(ISVNAuthenticationManager authManager,
ISVNOptions options)
Constructs and initializes an SVNStatusClient object
with the specified run-time configuration and authentication
drivers.
|
SVNStatusClient(ISVNRepositoryPool repositoryPool,
ISVNOptions options)
Constructs and initializes an SVNStatusClient object
with the specified run-time configuration and repository pool object.
|
Modifier and Type | Method and Description |
---|---|
SVNStatus |
doStatus(java.io.File path,
boolean remote)
Collects status information on a single Working Copy item.
|
SVNStatus |
doStatus(java.io.File path,
boolean remote,
boolean collectParentExternals)
Collects status information on a single Working Copy item.
|
long |
doStatus(java.io.File path,
boolean recursive,
boolean remote,
boolean reportAll,
boolean includeIgnored,
boolean collectParentExternals,
ISVNStatusHandler handler)
|
long |
doStatus(java.io.File path,
boolean recursive,
boolean remote,
boolean reportAll,
boolean includeIgnored,
ISVNStatusHandler handler)
|
long |
doStatus(java.io.File path,
SVNRevision revision,
boolean recursive,
boolean remote,
boolean reportAll,
boolean includeIgnored,
boolean collectParentExternals,
ISVNStatusHandler handler)
|
long |
doStatus(java.io.File path,
SVNRevision revision,
SVNDepth depth,
boolean remote,
boolean reportAll,
boolean includeIgnored,
boolean collectParentExternals,
ISVNStatusHandler handler,
java.util.Collection changeLists)
Given a
path to a working copy directory (or single file), calls handler
with a set of SVNStatus objects which describe the status of the path , and its
children (recursing according to depth ). |
void |
setFilesProvider(ISVNStatusFileProvider filesProvider) |
checkCancelled, createRepository, createRepository, createRepository, createWCAccess, createWCAccess, deriveLocation, dispatchEvent, dispatchEvent, elideMergeInfo, ensureSessionURL, getDebugLog, getEntryLocation, getEventDispatcher, getLevelsToLockFromDepth, getLocations, getOptions, getPathLastChangeRevision, getPathRelativeToRoot, getPathRelativeToSession, getRepositoryPool, getReposMergeInfo, getReposRoot, getRevisionNumber, getRevisionNumber, getURL, getWCMergeInfo, getWCOrRepositoryMergeInfo, handleEvent, handlePathListItem, isIgnoreExternals, isLeaveConflictsUnresolved, resolveRevisions, setCommitItemAccess, setCommitItemFlags, setCommitItemProperty, setDebugLog, setEventHandler, setEventPathPrefix, setIgnoreExternals, setLeaveConflictsUnresolved, setOptions, setPathListHandler, sleepForTimeStamp
public SVNStatusClient(ISVNAuthenticationManager authManager, ISVNOptions options)
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 driverpublic SVNStatusClient(ISVNRepositoryPool repositoryPool, ISVNOptions options)
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 repositoryPool
is null,
then SVNRepositoryFactory
will be used to create repository access objects
.repositoryPool
- a repository pool objectoptions
- a run-time configuration options driverpublic long doStatus(java.io.File path, boolean recursive, boolean remote, boolean reportAll, boolean includeIgnored, ISVNStatusHandler handler) throws SVNException
doStatus(File, SVNRevision, SVNDepth, boolean, boolean, boolean, boolean, ISVNStatusHandler, Collection)
insteadhandler
.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 informationSVNException
ISVNStatusHandler
public long doStatus(java.io.File path, boolean recursive, boolean remote, boolean reportAll, boolean includeIgnored, boolean collectParentExternals, ISVNStatusHandler handler) throws SVNException
doStatus(File, SVNRevision, SVNDepth, boolean, boolean, boolean, boolean, ISVNStatusHandler, Collection)
insteadhandler
.
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 informationSVNException
public long doStatus(java.io.File path, SVNRevision revision, boolean recursive, boolean remote, boolean reportAll, boolean includeIgnored, boolean collectParentExternals, ISVNStatusHandler handler) throws SVNException
doStatus(File, SVNRevision, SVNDepth, boolean, boolean, boolean, boolean, ISVNStatusHandler, Collection)
insteadhandler
.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 informationSVNException
public long doStatus(java.io.File path, SVNRevision revision, SVNDepth depth, boolean remote, boolean reportAll, boolean includeIgnored, boolean collectParentExternals, ISVNStatusHandler handler, java.util.Collection changeLists) throws SVNException
path
to a working copy directory (or single file), calls handler
with a set of SVNStatus
objects which describe the status of the path
, and its
children (recursing according to depth
).
If reportAll
is set, retrieves all entries; otherwise, retrieves only "interesting" entries
(local modifications and/or out of date).
If remote
is set, contacts the repository and augments the status objects with information
about out-of-dateness (with respect to revision
).
If SVNBasicClient.isIgnoreExternals()
returns false, then recurses into
externals definitions (if any exist and depth
is either SVNDepth.INFINITY
or
SVNDepth.UNKNOWN
) after handling the main target. This calls the client notification
handler (ISVNEventHandler
) with the SVNEventAction.STATUS_EXTERNAL
action before
handling each externals definition, and with SVNEventAction.STATUS_COMPLETED
after each.
changeLists
is a collection of String
changelist names, used as a restrictive
filter on items whose statuses are reported; that is, doesn't report status about any item unless
it's a member of one of those changelists. If changeLists
is empty (or
null), no changelist filtering occurs.path
- working copy pathrevision
- if remote
is true,
status is calculated against this revisiondepth
- tree depth to processremote
- 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
- obsolete (not used)handler
- a caller's status handler that will be involved
in processing status informationchangeLists
- collection with changelist namesremote
is setSVNException
public SVNStatus doStatus(java.io.File path, boolean remote) throws SVNException
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 falseSVNException
public SVNStatus doStatus(java.io.File path, boolean remote, boolean collectParentExternals) throws SVNException
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 falseSVNException
public void setFilesProvider(ISVNStatusFileProvider filesProvider)
Copyright © 2004-2011 TMate Software Ltd. All Rights Reserved.