Class SVNLogClient17
- All Implemented Interfaces:
ISVNCanceller
,ISVNEventHandler
Here's a list of the SVNLogClient's methods matched against corresponing commands of the SVN command line client:
SVNKit | Subversion |
doLog() | 'svn log' |
doList() | 'svn list' |
doAnnotate() | 'svn blame' |
- Since:
- 1.2
- Version:
- 1.3
-
Nested Class Summary
Nested classes/interfaces inherited from class org.tmatesoft.svn.core.internal.wc16.SVNBasicDelegate
SVNBasicDelegate.RepositoryReference, SVNBasicDelegate.SVNRepositoryLocation
-
Field Summary
FieldsFields inherited from interface org.tmatesoft.svn.core.ISVNCanceller
NULL
Fields inherited from interface org.tmatesoft.svn.core.wc.ISVNEventHandler
UNKNOWN
-
Constructor Summary
ConstructorsConstructorDescriptionSVNLogClient17
(ISVNAuthenticationManager authManager, ISVNOptions options) Constructs and initializes an SVNLogClient object with the specified run-time configuration and authentication drivers.SVNLogClient17
(ISVNRepositoryPool repositoryPool, ISVNOptions options) Constructs and initializes an SVNLogClient object with the specified run-time configuration and authentication drivers. -
Method Summary
Modifier and TypeMethodDescriptionvoid
doAnnotate
(java.io.File path, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean ignoreMimeType, boolean includeMergedRevisions, ISVNAnnotateHandler handler, java.lang.String inputEncoding) Invokeshandler
on each line-blame item associated with revisionendRevision
ofpath
, usingstartRevision
as the default source of all blame.void
doAnnotate
(java.io.File path, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean ignoreMimeType, ISVNAnnotateHandler handler) Obtains annotation information for each file text line from a repository (using a Working Copy path to get a corresponding URL) and passes it to a provided annotation handler.void
doAnnotate
(java.io.File path, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, ISVNAnnotateHandler handler) Obtains annotation information for each file text line from a repository (using a Working Copy path to get a corresponding URL) and passes it to a provided annotation handler.void
doAnnotate
(SVNURL url, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean ignoreMimeType, boolean includeMergedRevisions, ISVNAnnotateHandler handler, java.lang.String inputEncoding) Invokeshandler
on each line-blame item associated with revisionendRevision
ofurl
, usingstartRevision
as the default source of all blame.void
doAnnotate
(SVNURL url, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean ignoreMimeType, ISVNAnnotateHandler handler, java.lang.String inputEncoding) Obtains annotation information for each file text line from a repository and passes it to a provided annotation handler.void
doAnnotate
(SVNURL url, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, ISVNAnnotateHandler handler) Obtains annotation information for each file text line from a repository and passes it to a provided annotation handler.void
doAnnotate
(SVNURL url, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, ISVNAnnotateHandler handler, java.lang.String inputEncoding) Obtains annotation information for each file text line from a repository and passes it to a provided annotation handler.void
doList
(java.io.File path, SVNRevision pegRevision, SVNRevision revision, boolean fetchLocks, boolean recursive, ISVNDirEntryHandler handler) Deprecated.void
doList
(java.io.File path, SVNRevision pegRevision, SVNRevision revision, boolean recursive, ISVNDirEntryHandler handler) Deprecated.void
doList
(java.io.File path, SVNRevision pegRevision, SVNRevision revision, boolean fetchLocks, SVNDepth depth, int entryFields, ISVNDirEntryHandler handler) Reports the directory entry, and possibly children, forpath
atrevision
.void
doList
(SVNURL url, SVNRevision pegRevision, SVNRevision revision, boolean fetchLocks, boolean recursive, ISVNDirEntryHandler handler) Browses directory entries from a repository and uses the provided dir entry handler to process them.void
doList
(SVNURL url, SVNRevision pegRevision, SVNRevision revision, boolean recursive, ISVNDirEntryHandler handler) Deprecated.void
doList
(SVNURL url, SVNRevision pegRevision, SVNRevision revision, boolean fetchLocks, SVNDepth depth, int entryFields, ISVNDirEntryHandler handler) Reports the directory entry, and possibly children, forurl
atrevision
.void
doLog
(java.io.File[] paths, java.util.Collection revisionRanges, SVNRevision pegRevision, boolean stopOnCopy, boolean discoverChangedPaths, boolean includeMergedRevisions, long limit, java.lang.String[] revisionProperties, ISVNLogEntryHandler handler) Invokeshandler
on each log message from the givenrevisionRanges
in turn, inclusive (but never invokeshandler
on a given log message more than once).void
doLog
(java.io.File[] paths, SVNRevision startRevision, SVNRevision endRevision, boolean stopOnCopy, boolean discoverChangedPaths, long limit, ISVNLogEntryHandler handler) Gets commit log messages with other revision specific information from a repository (using Working Copy paths to get corresponding URLs) and passes them to a log entry handler for processing.void
doLog
(java.io.File[] paths, SVNRevision startRevision, SVNRevision endRevision, SVNRevision pegRevision, boolean stopOnCopy, boolean discoverChangedPaths, boolean includeMergedRevisions, long limit, java.lang.String[] revisionProperties, ISVNLogEntryHandler handler) Invokeshandler
on each log message fromstartRevision
toendRevision
in turn, inclusive (but never invokeshandler
on a given log message more than once).void
doLog
(java.io.File[] paths, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean stopOnCopy, boolean discoverChangedPaths, long limit, ISVNLogEntryHandler handler) Gets commit log messages with other revision specific information from a repository (using Working Copy paths to get corresponding URLs) and passes them to a log entry handler for processing.void
doLog
(SVNURL url, java.lang.String[] paths, SVNRevision pegRevision, java.util.Collection revisionRanges, boolean stopOnCopy, boolean discoverChangedPaths, boolean includeMergedRevisions, long limit, java.lang.String[] revisionProperties, ISVNLogEntryHandler handler) Invokeshandler
on each log message from the givenin turn, inclusive (but never invokes
handler
on a given log message more than once).void
doLog
(SVNURL url, java.lang.String[] paths, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean stopOnCopy, boolean discoverChangedPaths, boolean includeMergedRevisions, long limit, java.lang.String[] revisionProperties, ISVNLogEntryHandler handler) Invokeshandler
on each log message fromstartRevision
toendRevision
in turn, inclusive (but never invokeshandler
on a given log message more than once).void
doLog
(SVNURL url, java.lang.String[] paths, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean stopOnCopy, boolean discoverChangedPaths, long limit, ISVNLogEntryHandler handler) Gets commit log messages with other revision specific information from a repository and passes them to a log entry handler for processing.Gets the diff options that are used in annotate operations by this client.void
setDiffOptions
(SVNDiffOptions diffOptions) Sets diff options for this client to use in annotate operations.Methods inherited from class org.tmatesoft.svn.core.internal.wc16.SVNBasicDelegate
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
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
myDiffOptions
-
-
Constructor Details
-
SVNLogClient17
Constructs and initializes an SVNLogClient object with the specified run-time configuration and authentication drivers.If
options
is null, then this SVNLogClient 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 onISVNOptions
andSVNWCUtil
).If
authManager
is null, then this SVNLogClient will be using a default authentication and network layers driver (seeSVNWCUtil.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 driveroptions
- a run-time configuration options driver
-
SVNLogClient17
Constructs and initializes an SVNLogClient object with the specified run-time configuration and authentication drivers.If
Ifoptions
is null, then this SVNLogClient 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 onISVNOptions
andSVNWCUtil
).repositoryPool
is null, thenSVNRepositoryFactory
will be used to createrepository access objects
.- Parameters:
repositoryPool
- a repository pool objectoptions
- a run-time configuration options driver
-
-
Method Details
-
setDiffOptions
Sets diff options for this client to use in annotate operations.- Parameters:
diffOptions
- diff options object
-
getDiffOptions
Gets the diff options that are used in annotate operations by this client. Creates a new one if none was used before.- Returns:
- diff options
-
doAnnotate
public void doAnnotate(java.io.File path, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, ISVNAnnotateHandler handler) throws SVNException Obtains annotation information for each file text line from a repository (using a Working Copy path to get a corresponding URL) and passes it to a provided annotation handler. This method is equivalent to a call todoAnnotate(path, pegRevision, startRevision, endRevision, false, false, handler, null)
.- Parameters:
path
- a WC file item to be annotatedpegRevision
- a revision in whichpath
is first looked up in the repositorystartRevision
- a revision for an operation to start fromendRevision
- a revision for an operation to stop athandler
- a caller's handler to process annotation information- Throws:
SVNException
- ifstartRevision > endRevision
- See Also:
-
doAnnotate
public void doAnnotate(java.io.File path, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean ignoreMimeType, ISVNAnnotateHandler handler) throws SVNException Obtains annotation information for each file text line from a repository (using a Working Copy path to get a corresponding URL) and passes it to a provided annotation handler. This method is equivalent to a call todoAnnotate(path, pegRevision, startRevision, endRevision, ignoreMimeType, false, handler, null)
.- Parameters:
path
- a WC file item to be annotatedpegRevision
- a revision in whichpath
is first looked up in the repositorystartRevision
- a revision for an operation to start fromendRevision
- a revision for an operation to stop atignoreMimeType
- forces operation to run (all files to be treated as text, no matter what SVNKit has inferred from the mime-type property)handler
- a caller's handler to process annotation information- Throws:
SVNException
- Since:
- 1.1
- See Also:
-
doAnnotate
public void doAnnotate(java.io.File path, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean ignoreMimeType, boolean includeMergedRevisions, ISVNAnnotateHandler handler, java.lang.String inputEncoding) throws SVNException Invokeshandler
on each line-blame item associated with revisionendRevision
ofpath
, usingstartRevision
as the default source of all blame.pegRevision
indicates in which revisionpath
is valid. IfpegRevision
isSVNRevision.UNDEFINED
, then it defaults toSVNRevision.WORKING
. IfstartRevision
is null orinvalid
, then it defaults to revision 1. IfendRevision
is null orinvalid
, then in defaults toSVNRevision.HEAD
. Note: this routine requires repository access.- Parameters:
path
- a WC file item to be annotatedpegRevision
- a revision in whichpath
is first looked up in the repositorystartRevision
- a revision for an operation to start fromendRevision
- a revision for an operation to stop atignoreMimeType
- forces operation to run (all files to be treated as text, no matter what SVNKit has inferred from the mime-type property)includeMergedRevisions
- if true, then also returns data based upon revisions which have been merged topath
handler
- a caller's handler to process annotation informationinputEncoding
- character set to decode input bytes with- Throws:
SVNException
- in the following cases:-
exception with
SVNErrorCode.CLIENT_BAD_REVISION
error code - if bothstartRevision
andendRevision
are either null orinvalid
exception withSVNErrorCode.UNSUPPORTED_FEATURE
error code - if either ofstartRevision
orendRevision
isSVNRevision.WORKING
exception withSVNErrorCode.CLIENT_IS_BINARY_FILE
error code - if any of the revisions ofpath
have a binary mime-type, unlessignoreMimeType
is true, in which case blame information will be generated regardless of the MIME types of the revisions- Since:
- 1.2, SVN 1.5
-
doAnnotate
public void doAnnotate(SVNURL url, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, ISVNAnnotateHandler handler) throws SVNException Obtains annotation information for each file text line from a repository and passes it to a provided annotation handler.This method is equivalent to a call to
doAnnotate(url, pegRevision, startRevision, endRevision, false, false, handler, null)
.- Parameters:
url
- a URL of a text file that is to be annotatedpegRevision
- a revision in whichpath
is first looked up in the repositorystartRevision
- a revision for an operation to start fromendRevision
- a revision for an operation to stop athandler
- a caller's handler to process annotation information- Throws:
SVNException
- ifstartRevision > endRevision
- See Also:
-
doAnnotate
public void doAnnotate(SVNURL url, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, ISVNAnnotateHandler handler, java.lang.String inputEncoding) throws SVNException Obtains annotation information for each file text line from a repository and passes it to a provided annotation handler.This method is equivalent to a call to
doAnnotate(url, pegRevision, startRevision, endRevision, false, false, handler, inputEncoding)
.- Parameters:
url
- a URL of a text file that is to be annotatedpegRevision
- a revision in whichpath
is first looked up in the repositorystartRevision
- a revision for an operation to start fromendRevision
- a revision for an operation to stop athandler
- a caller's handler to process annotation informationinputEncoding
- a desired character set (encoding) of text lines- Throws:
SVNException
- See Also:
-
doAnnotate
public void doAnnotate(SVNURL url, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean ignoreMimeType, ISVNAnnotateHandler handler, java.lang.String inputEncoding) throws SVNException Obtains annotation information for each file text line from a repository and passes it to a provided annotation handler.This method is equivalent to a call to
doAnnotate(url, pegRevision, startRevision, endRevision, ignoreMimeType, false, handler, inputEncoding)
.- Parameters:
url
- a URL of a text file that is to be annotatedpegRevision
- a revision in whichpath
is first looked up in the repositorystartRevision
- a revision for an operation to start fromendRevision
- a revision for an operation to stop atignoreMimeType
- forces operation to run (all files to be treated as text, no matter what SVNKit has inferred from the mime-type property)handler
- a caller's handler to process annotation informationinputEncoding
- a desired character set (encoding) of text lines- Throws:
SVNException
- Since:
- 1.1
- See Also:
-
doAnnotate
public void doAnnotate(SVNURL url, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean ignoreMimeType, boolean includeMergedRevisions, ISVNAnnotateHandler handler, java.lang.String inputEncoding) throws SVNException Invokeshandler
on each line-blame item associated with revisionendRevision
ofurl
, usingstartRevision
as the default source of all blame.pegRevision
indicates in which revisionurl
is valid. IfpegRevision
isSVNRevision.UNDEFINED
, then it defaults toSVNRevision.HEAD
. IfstartRevision
is null orinvalid
, then it defaults to revision 1. IfendRevision
is null orinvalid
, then in defaults toSVNRevision.HEAD
. Note: this routine requires repository access- Parameters:
url
- a URL of a text file that is to be annotatedpegRevision
- a revision in whichurl
is first looked up in the repositorystartRevision
- a revision for an operation to start fromendRevision
- a revision for an operation to stop atignoreMimeType
- forces operation to run (all files to be treated as text, no matter what SVNKit has inferred from the mime-type property)includeMergedRevisions
- if true, then also returns data based upon revisions which have been merged tourl
handler
- a caller's handler to process annotation informationinputEncoding
- character set to decode input bytes with- Throws:
SVNException
- in the following cases:-
exception with
SVNErrorCode.CLIENT_BAD_REVISION
error code - if bothstartRevision
andendRevision
are either null orinvalid
exception withSVNErrorCode.UNSUPPORTED_FEATURE
error code - if either ofstartRevision
orendRevision
isSVNRevision.WORKING
exception withSVNErrorCode.CLIENT_IS_BINARY_FILE
error code - if any of the revisions ofurl
have a binary mime-type, unlessignoreMimeType
is true, in which case blame information will be generated regardless of the MIME types of the revisions- Since:
- 1.2, SVN 1.5
-
doLog
public void doLog(java.io.File[] paths, SVNRevision startRevision, SVNRevision endRevision, boolean stopOnCopy, boolean discoverChangedPaths, long limit, ISVNLogEntryHandler handler) throws SVNException Gets commit log messages with other revision specific information from a repository (using Working Copy paths to get corresponding URLs) and passes them to a log entry handler for processing. Useful for observing the history of affected paths, author, date and log comments information per revision.Calling this method is equivalent to
doLog(paths, startRevision, endRevision, SVNRevision.UNDEFINED, stopOnCopy, discoverChangedPaths, false, limit, null, handler)
.- Parameters:
paths
- an array of Working Copy paths, should not be nullstartRevision
- a revision for an operation to start from (including this revision)endRevision
- a revision for an operation to stop at (including this revision)stopOnCopy
- true not to cross copies while traversing history, otherwise copies history will be also included into processingdiscoverChangedPaths
- true to report of all changed paths for every revision being processed (those paths will be available by callingSVNLogEntry.getChangedPaths()
)limit
- a maximum number of log entries to be processedhandler
- a caller's log entry handler- Throws:
SVNException
- if one of the following is true:- a path is not under version control
- can not obtain a URL of a WC path - there's no such entry in the Working Copy
paths
contain entries that belong to different repositories
- See Also:
-
doLog
public void doLog(java.io.File[] paths, SVNRevision startRevision, SVNRevision endRevision, SVNRevision pegRevision, boolean stopOnCopy, boolean discoverChangedPaths, boolean includeMergedRevisions, long limit, java.lang.String[] revisionProperties, ISVNLogEntryHandler handler) throws SVNException Invokeshandler
on each log message fromstartRevision
toendRevision
in turn, inclusive (but never invokeshandler
on a given log message more than once).handler
is invoked only on messages whose revisions involved a change to some path inpaths
.pegRevision
indicates in which revisionpaths
are valid. IfpegRevision
isinvalid
, it defaults toSVNRevision.WORKING
. Iflimit
is non-zero, only invokeshandler
on the firstlimit
logs. IfdiscoverChangedPaths
is set, then the changed pathsMap
argument will be passed to a constructor ofSVNLogEntry
on each invocation ofhandler
. IfstopOnCopy
is set, copy history (if any exists) will not be traversed while harvesting revision logs for each target. IfincludeMergedRevisions
is set, log information for revisions which have been merged topaths
will also be returned. Refer toSVNLogEntry.hasChildren()
for additional information on how to handle mergeinfo information during a log operation. IfrevisionProperties is null, retrieves all revision properties; else, retrieves only the revprops named in the array (i.e. retrieves none if the array is empty). If
startRevision
isvalid
butendRevision
is not, thenendRevision
defaults tostartRevision
. If bothstartRevision
andendRevision
are invalid, thenendRevision
defaults to revision0
, andstartRevision
defaults either topegRevision
in case the latter one is valid, or toSVNRevision.BASE
, if it is not. Important: to avoid an exception with theSVNErrorCode.FS_NO_SUCH_REVISION
error code when invoked against an empty repository (i.e. one not containing a revision 1), callers should specify the rangeSVNRevision.HEAD
:0
. If the caller has provided a non-nullISVNEventHandler
, it will be called with theSVNEventAction.SKIP
event action on any unversioned paths. Note: this routine requires repository access.- Parameters:
paths
- an array of Working Copy paths, for which log messages are desiredstartRevision
- a revision for an operation to start from (including this revision)endRevision
- a revision for an operation to stop at (including this revision)pegRevision
- a revision in whichpaths
are first looked up in the repositorystopOnCopy
- true not to cross copies while traversing history, otherwise copies history will be also included into processingdiscoverChangedPaths
- true to report of all changed paths for every revision being processed (those paths will be available by callingSVNLogEntry.getChangedPaths()
)includeMergedRevisions
- if true, merged revisions will be also reportedlimit
- a maximum number of log entries to be processedrevisionProperties
- names of revision properties to retrievehandler
- a caller's log entry handler- Throws:
SVNException
- if one of the following is true:- can not obtain a URL of a WC path - there's no such entry in the Working Copy
paths
contain entries that belong to different repositories
- Since:
- 1.2, SVN 1.5
-
doLog
public void doLog(java.io.File[] paths, java.util.Collection revisionRanges, SVNRevision pegRevision, boolean stopOnCopy, boolean discoverChangedPaths, boolean includeMergedRevisions, long limit, java.lang.String[] revisionProperties, ISVNLogEntryHandler handler) throws SVNException Invokeshandler
on each log message from the givenrevisionRanges
in turn, inclusive (but never invokeshandler
on a given log message more than once).handler
is invoked only on messages whose revisions involved a change to some path inpaths
.pegRevision
indicates in which revisionpaths
are valid. IfpegRevision
isinvalid
, it defaults toSVNRevision.WORKING
. Iflimit
is non-zero, only invokeshandler
on the firstlimit
logs. IfdiscoverChangedPaths
is set, then the changed pathsMap
argument will be passed to a constructor ofSVNLogEntry
on each invocation ofhandler
. IfstopOnCopy
is set, copy history (if any exists) will not be traversed while harvesting revision logs for each target. IfincludeMergedRevisions
is set, log information for revisions which have been merged topaths
will also be returned. Refer toSVNLogEntry.hasChildren()
for additional information on how to handle mergeinfo information during a log operation. IfrevisionProperties is null, retrieves all revision properties; else, retrieves only the revprops named in the array (i.e. retrieves none if the array is empty). For every
SVNRevisionRange
inrevisionRanges
: IfstartRevision
isvalid
butendRevision
is not, thenendRevision
defaults tostartRevision
. If bothstartRevision
andendRevision
are invalid, thenendRevision
defaults to revision0
, andstartRevision
defaults either topegRevision
in case the latter one is valid, or toSVNRevision.BASE
, if it is not. Important: to avoid an exception with theSVNErrorCode.FS_NO_SUCH_REVISION
error code when invoked against an empty repository (i.e. one not containing a revision 1), callers should specify the rangeSVNRevision.HEAD
:0
. If the caller has provided a non-nullISVNEventHandler
, it will be called with theSVNEventAction.SKIP
event action on any unversioned paths. Note: this routine requires repository access.- Parameters:
paths
- an array of Working Copy paths, for which log messages are desiredrevisionRanges
- collection ofSVNRevisionRange
objectspegRevision
- a revision in whichpaths
are first looked up in the repositorystopOnCopy
- true not to cross copies while traversing history, otherwise copies history will be also included into processingdiscoverChangedPaths
- true to report of all changed paths for every revision being processed (those paths will be available by callingSVNLogEntry.getChangedPaths()
)includeMergedRevisions
- if true, merged revisions will be also reportedlimit
- a maximum number of log entries to be processedrevisionProperties
- names of revision properties to retrievehandler
- a caller's log entry handler- Throws:
SVNException
- if one of the following is true:- can not obtain a URL of a WC path - there's no such entry in the Working Copy
paths
contain entries that belong to different repositories
- Since:
- 1.3, SVN 1.6
-
doLog
public void doLog(java.io.File[] paths, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean stopOnCopy, boolean discoverChangedPaths, long limit, ISVNLogEntryHandler handler) throws SVNException Gets commit log messages with other revision specific information from a repository (using Working Copy paths to get corresponding URLs) and passes them to a log entry handler for processing. Useful for observing the history of affected paths, author, date and log comments information per revision.Calling this method is equivalent to
doLog(paths, startRevision, endRevision, pegRevision, stopOnCopy, discoverChangedPaths, false, limit, null, handler)
.- Parameters:
paths
- an array of Working Copy paths, should not be nullpegRevision
- a revision in whichpath
is first looked up in the repositorystartRevision
- a revision for an operation to start from (including this revision)endRevision
- a revision for an operation to stop at (including this revision)stopOnCopy
- true not to cross copies while traversing history, otherwise copies history will be also included into processingdiscoverChangedPaths
- true to report of all changed paths for every revision being processed (those paths will be available by callingSVNLogEntry.getChangedPaths()
)limit
- a maximum number of log entries to be processedhandler
- a caller's log entry handler- Throws:
SVNException
- if one of the following is true:- a path is not under version control
- can not obtain a URL of a WC path - there's no such entry in the Working Copy
paths
contain entries that belong to different repositories
- See Also:
-
doLog
public void doLog(SVNURL url, java.lang.String[] paths, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean stopOnCopy, boolean discoverChangedPaths, long limit, ISVNLogEntryHandler handler) throws SVNException Gets commit log messages with other revision specific information from a repository and passes them to a log entry handler for processing. Useful for observing the history of affected paths, author, date and log comments information per revision.Calling this method is equivalent to
doLog(url, paths, pegRevision, startRevision, endRevision, stopOnCopy, discoverChangedPaths, false, limit, null, handler)
.- Parameters:
url
- a target URLpaths
- an array of paths relative to the targeturl
pegRevision
- a revision in whichurl
is first looked upstartRevision
- a revision for an operation to start from (including this revision)endRevision
- a revision for an operation to stop at (including this revision)stopOnCopy
- true not to cross copies while traversing history, otherwise copies history will be also included into processingdiscoverChangedPaths
- true to report of all changed paths for every revision being processed (those paths will be available by callingSVNLogEntry.getChangedPaths()
)limit
- a maximum number of log entries to be processedhandler
- a caller's log entry handler- Throws:
SVNException
- Since:
- 1.1, new in Subversion 1.4
- See Also:
-
doLog
public void doLog(SVNURL url, java.lang.String[] paths, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean stopOnCopy, boolean discoverChangedPaths, boolean includeMergedRevisions, long limit, java.lang.String[] revisionProperties, ISVNLogEntryHandler handler) throws SVNException Invokeshandler
on each log message fromstartRevision
toendRevision
in turn, inclusive (but never invokeshandler
on a given log message more than once).handler
is invoked only on messages whose revisions involved a change to some path inpaths
.pegRevision
indicates in which revisionpaths
are valid. IfpegRevision
isinvalid
, it defaults toSVNRevision.HEAD
. Iflimit
is non-zero, only invokeshandler
on the firstlimit
logs. IfdiscoverChangedPaths
is set, then the changed pathsMap
argument will be passed to a constructor ofSVNLogEntry
on each invocation ofhandler
. IfstopOnCopy
is set, copy history (if any exists) will not be traversed while harvesting revision logs for each target. IfincludeMergedRevisions
is set, log information for revisions which have been merged topaths
will also be returned. IfrevisionProperties is null, retrieves all revision properties; else, retrieves only the revision properties named in the array (i.e. retrieves none if the array is empty). Important: to avoid an exception with the
SVNErrorCode.FS_NO_SUCH_REVISION
error code when invoked against an empty repository (i.e. one not containing a revision 1), callers should specify the rangeSVNRevision.HEAD
:0
. Note: this routine requires repository access.- Parameters:
url
- repository URLpaths
- an array of paths relative tourl
pegRevision
- a revision in whichpaths
are first looked up in the repositorystartRevision
- a revision for an operation to start from (including this revision)endRevision
- a revision for an operation to stop at (including this revision)stopOnCopy
- true not to cross copies while traversing history, otherwise copies history will be also included into processingdiscoverChangedPaths
- true to report of all changed paths for every revision being processed (those paths will be available by callingSVNLogEntry.getChangedPaths()
)includeMergedRevisions
- if true, merged revisions will be also reportedlimit
- a maximum number of log entries to be processedrevisionProperties
- names of revision properties to retrievehandler
- a caller's log entry handler- Throws:
SVNException
- Since:
- 1.2, SVN 1.5
-
doLog
public void doLog(SVNURL url, java.lang.String[] paths, SVNRevision pegRevision, java.util.Collection revisionRanges, boolean stopOnCopy, boolean discoverChangedPaths, boolean includeMergedRevisions, long limit, java.lang.String[] revisionProperties, ISVNLogEntryHandler handler) throws SVNException Invokeshandler
on each log message from the givenin turn, inclusive (but never invokes
handler
on a given log message more than once).handler
is invoked only on messages whose revisions involved a change to some path inpaths
.pegRevision
indicates in which revisionpaths
are valid. IfpegRevision
isinvalid
, it defaults toSVNRevision.HEAD
. Iflimit
is non-zero, only invokeshandler
on the firstlimit
logs. IfdiscoverChangedPaths
is set, then the changed pathsMap
argument will be passed to a constructor ofSVNLogEntry
on each invocation ofhandler
. IfstopOnCopy
is set, copy history (if any exists) will not be traversed while harvesting revision logs for each target. IfincludeMergedRevisions
is set, log information for revisions which have been merged topaths
will also be returned. IfrevisionProperties is null, retrieves all revision properties; else, retrieves only the revision properties named in the array (i.e. retrieves none if the array is empty). Important: to avoid an exception with the
SVNErrorCode.FS_NO_SUCH_REVISION
error code when invoked against an empty repository (i.e. one not containing a revision 1), callers should specify the rangeSVNRevision.HEAD
:0
. Note: this routine requires repository access.- Parameters:
url
- repository URLpaths
- an array of paths relative tourl
pegRevision
- a revision in whichpaths
are first looked up in the repositoryrevisionRanges
- collection ofSVNRevisionRange
objectsstopOnCopy
- true not to cross copies while traversing history, otherwise copies history will be also included into processingdiscoverChangedPaths
- true to report of all changed paths for every revision being processed (those paths will be available by callingSVNLogEntry.getChangedPaths()
)includeMergedRevisions
- if true, merged revisions will be also reportedlimit
- a maximum number of log entries to be processedrevisionProperties
- names of revision properties to retrievehandler
- a caller's log entry handler- Throws:
SVNException
- Since:
- 1.3, SVN 1.6
-
doList
public void doList(java.io.File path, SVNRevision pegRevision, SVNRevision revision, boolean fetchLocks, boolean recursive, ISVNDirEntryHandler handler) throws SVNException Deprecated.Browses directory entries from a repository (using Working Copy paths to get corresponding URLs) and uses the provided dir entry handler to process them.On every entry that this method stops it gets some useful entry information which is packed into an
SVNDirEntry
object and passed to thehandler
'shandleDirEntry()
method.- Parameters:
path
- a WC item to get its repository locationpegRevision
- a revision in which the item's URL is first looked uprevision
- a target revisionfetchLocks
- true to fetch locks information from a repositoryrecursive
- true to descend recursively (relevant for directories)handler
- a caller's directory entry handler (to process info on an entry)- Throws:
SVNException
-
doList
public void doList(java.io.File path, SVNRevision pegRevision, SVNRevision revision, boolean fetchLocks, SVNDepth depth, int entryFields, ISVNDirEntryHandler handler) throws SVNException Reports the directory entry, and possibly children, forpath
atrevision
. The actual node revision selected is determined by the path as it exists inpegRevision
. IfpegRevision
isinvalid
, then it defaults toSVNRevision.WORKING
. Reports directory entries by invokinghandler
,setting
a relative topath
path to theSVNDirEntry
object. The directory entry forpath
is reported using an empty path. Ifpath
is a directory, also reports its children. Ifdepth
isSVNDepth.EMPTY
, lists justpath
itself. Ifdepth
isSVNDepth.FILES
, listspath
and its file entries. IfSVNDepth.IMMEDIATES
, lists its immediate file and directory entries. IfSVNDepth.INFINITY
, lists file entries and recurses (withSVNDepth.INFINITY
) on directory entries.entryFields
controls which fields in theSVNDirEntry
are filled in. To have them totally filled in useSVNDirEntry.DIRENT_ALL
, otherwise simply bitwise OR together the combination of fields you care about. Note: this routine requires repository access.- Parameters:
path
- a WC item to get its repository locationpegRevision
- a revision in which the item's URL is first looked uprevision
- a target revisionfetchLocks
- true, includes locks when reporting directory entriesdepth
- tree depth to processentryFields
- entry fields to fillhandler
- a caller's directory entry handler (to process info on an entry)- Throws:
SVNException
- in the following cases:-
exception with
SVNErrorCode.FS_NOT_FOUND
error code - ifpath
is non-existent in the repository- Since:
- 1.2, SVN 1.5
-
doList
public void doList(java.io.File path, SVNRevision pegRevision, SVNRevision revision, boolean recursive, ISVNDirEntryHandler handler) throws SVNException Deprecated.Browses directory entries from a repository (using Working Copy paths to get corresponding URLs) and uses the provided dir entry handler to process them.On every entry that this method stops it gets some useful entry information which is packed into an
SVNDirEntry
object and passed to thehandler
'shandleDirEntry()
method.- Parameters:
path
- a WC item to get its repository locationpegRevision
- a revision in which the item's URL is first looked uprevision
- a target revisionrecursive
- true to descend recursively (relevant for directories)handler
- a caller's directory entry handler (to process info on an entry)- Throws:
SVNException
-
doList
public void doList(SVNURL url, SVNRevision pegRevision, SVNRevision revision, boolean fetchLocks, boolean recursive, ISVNDirEntryHandler handler) throws SVNException Browses directory entries from a repository and uses the provided dir entry handler to process them. This method is especially useful when having no Working Copy.On every entry that this method stops it gets some useful entry information which is packed into an
SVNDirEntry
object and passed to thehandler
'shandleDirEntry()
method.- Parameters:
url
- a repository location to be "listed"pegRevision
- a revision in which the item's URL is first looked uprevision
- a target revisionfetchLocks
- true to fetch locks information from repositoryrecursive
- true to descend recursively (relevant for directories)handler
- a caller's directory entry handler (to process info on an entry)- Throws:
SVNException
- See Also:
-
doList
public void doList(SVNURL url, SVNRevision pegRevision, SVNRevision revision, boolean fetchLocks, SVNDepth depth, int entryFields, ISVNDirEntryHandler handler) throws SVNException Reports the directory entry, and possibly children, forurl
atrevision
. The actual node revision selected is determined by the path as it exists inpegRevision
. IfpegRevision
isinvalid
, then it defaults toSVNRevision.HEAD
. Reports directory entries by invokinghandler
,setting
a relative tourl
path to theSVNDirEntry
object. The directory entry forurl
is reported using an empty path. Ifurl
is a directory, also reports its children. Ifdepth
isSVNDepth.EMPTY
, lists justurl
itself. Ifdepth
isSVNDepth.FILES
, listsurl
and its file entries. IfSVNDepth.IMMEDIATES
, lists its immediate file and directory entries. IfSVNDepth.INFINITY
, lists file entries and recurses (withSVNDepth.INFINITY
) on directory entries.entryFields
controls which fields in theSVNDirEntry
are filled in. To have them totally filled in useSVNDirEntry.DIRENT_ALL
, otherwise simply bitwise OR together the combination of fields you care about. Note: this routine requires repository access.- Parameters:
url
- a repository url to be "listed"pegRevision
- a revision in which the item's URL is first looked uprevision
- a target revisionfetchLocks
- true, includes locks when reporting directory entriesdepth
- tree depth to processentryFields
- entry fields to fillhandler
- a caller's directory entry handler (to process info on an entry)- Throws:
SVNException
- in the following cases:-
exception with
SVNErrorCode.FS_NOT_FOUND
error code - ifurl
is non-existent in the repository- Since:
- 1.2, SVN 1.5
-
doList
public void doList(SVNURL url, SVNRevision pegRevision, SVNRevision revision, boolean recursive, ISVNDirEntryHandler handler) throws SVNException Deprecated.Browses directory entries from a repository and uses the provided dir entry handler to process them. This method is especially useful when having no Working Copy.On every entry that this method stops it gets some useful entry information which is packed into an
SVNDirEntry
object and passed to thehandler
'shandleDirEntry()
method.- Parameters:
url
- a repository location to be "listed"pegRevision
- a revision in which the item's URL is first looked uprevision
- a target revisionrecursive
- true to descend recursively (relevant for directories)handler
- a caller's directory entry handler (to process info on an entry)- Throws:
SVNException
-
doList(File,SVNRevision,SVNRevision,boolean,SVNDepth,int,ISVNDirEntryHandler)
instead