| java.lang.Object
 org.tmatesoft.svn.core.wc.SVNBasicClient
org.tmatesoft.svn.core.wc.SVNLogClient
| SVNLogClient | | public class SVNLogClient extends SVNBasicClient (Code) | | The SVNLogClient class is intended for such purposes as getting
revisions history, browsing repository entries and annotating file contents.
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' |
version:
1.1.1
author:
TMate Software Ltd. |
| Constructor Summary | |
| public | SVNLogClient(ISVNAuthenticationManager authManager, ISVNOptions options)
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 on
ISVNOptions and
SVNWCUtil ). | | public | SVNLogClient(ISVNRepositoryPool repositoryPool, ISVNOptions options)
|
| Method Summary | |
| public void | doAnnotate(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. | | public void | doAnnotate(File path, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean force, 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. | | public 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. | | public void | doAnnotate(SVNURL url, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, ISVNAnnotateHandler handler, String inputEncoding)
Obtains annotation information for each file text line from a repository
and passes it to a provided annotation handler. | | public void | doAnnotate(SVNURL url, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean force, ISVNAnnotateHandler handler, String inputEncoding)
Obtains annotation information for each file text line from a repository
and passes it to a provided annotation handler. | | public void | doList(File path, SVNRevision pegRevision, SVNRevision revision, boolean fetchLocks, boolean recursive, ISVNDirEntryHandler handler)
Browses directory entries from a repository (using Working
Copy paths to get corresponding URLs) and uses the provided dir
entry handler to process them. | | public void | doList(File path, SVNRevision pegRevision, SVNRevision revision, boolean recursive, ISVNDirEntryHandler handler)
Browses directory entries from a repository (using Working
Copy paths to get corresponding URLs) and uses the provided dir
entry handler to process them. | | public 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. | | public void | doList(SVNURL url, SVNRevision pegRevision, SVNRevision revision, boolean recursive, ISVNDirEntryHandler handler)
Browses directory entries from a repository and uses the provided
dir entry handler to process them. | | public void | doLog(File[] paths, SVNRevision startRevision, SVNRevision endRevision, boolean stopOnCopy, boolean reportPaths, 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. | | public void | doLog(File[] paths, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean stopOnCopy, boolean reportPaths, 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. | | public void | doLog(SVNURL url, String[] paths, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean stopOnCopy, boolean reportPaths, 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. | | public SVNDiffOptions | getDiffOptions()
Gets the diff options that are used in annotate operations
by this client. | | public void | setDiffOptions(SVNDiffOptions diffOptions)
Sets diff options for this client to use in annotate operations. |
| SVNLogClient | | public SVNLogClient(ISVNAuthenticationManager authManager, ISVNOptions options)(Code) | | 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 on
ISVNOptions and
SVNWCUtil ).
If authManager is null,
then this SVNLogClient 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 |
| doAnnotate | | public void doAnnotate(File path, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, ISVNAnnotateHandler handler) throws SVNException(Code) | | 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.
If startRevision is invalid (for example,
startRevision =
SVNRevision.UNDEFINED UNDEFINED ) then
it's set to revision 1.
Calling this method is equivalent to
doAnnotate(path, pegRevision, startRevision, endRevision, false, handler).
Parameters:
path - a WC file item to be annotated
Parameters:
pegRevision - a revision in which path is first looked upin the repository
Parameters:
startRevision - a revision for an operation to start from
Parameters:
endRevision - a revision for an operation to stop at
Parameters:
handler - a caller's handler to process annotation information
throws:
SVNException - if startRevision > endRevision
See Also: SVNLogClient.doAnnotate(SVNURL,SVNRevision,SVNRevision,SVNRevision,ISVNAnnotateHandler) |
| doAnnotate | | public void doAnnotate(File path, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean force, ISVNAnnotateHandler handler) throws SVNException(Code) | | 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.
If startRevision is invalid (for example,
startRevision =
SVNRevision.UNDEFINED UNDEFINED ) then
it's set to revision 1.
Parameters:
path - a WC file item to be annotated
Parameters:
pegRevision - a revision in which path is first looked upin the repository
Parameters:
startRevision - a revision for an operation to start from
Parameters:
endRevision - a revision for an operation to stop at
Parameters:
force - forces operation to run (all files to be treated as text, no matter what SVNKit has inferred from the mime-type property)
Parameters:
handler - a caller's handler to process annotation information
throws:
SVNException -
since:
1.1 |
| doAnnotate | | public void doAnnotate(SVNURL url, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, ISVNAnnotateHandler handler) throws SVNException(Code) | | Obtains annotation information for each file text line from a repository
and passes it to a provided annotation handler.
If startRevision is invalid (for example,
startRevision =
SVNRevision.UNDEFINED UNDEFINED ) then
it's set to revision 1.
Calling this method is equivalent to
doAnnotate(url, pegRevision, startRevision, endRevision, handler, null).
Parameters:
url - a URL of a text file that is to be annotated
Parameters:
pegRevision - a revision in which path is first looked upin the repository
Parameters:
startRevision - a revision for an operation to start from
Parameters:
endRevision - a revision for an operation to stop at
Parameters:
handler - a caller's handler to process annotation information
throws:
SVNException - if startRevision > endRevision
See Also: SVNLogClient.doAnnotate(File,SVNRevision,SVNRevision,SVNRevision,ISVNAnnotateHandler) |
| doAnnotate | | public void doAnnotate(SVNURL url, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, ISVNAnnotateHandler handler, String inputEncoding) throws SVNException(Code) | | Obtains annotation information for each file text line from a repository
and passes it to a provided annotation handler.
If startRevision is invalid (for example,
startRevision =
SVNRevision.UNDEFINED UNDEFINED ) then
it's set to revision 1.
Calling this method is equivalent to
doAnnotate(url, pegRevision, startRevision, endRevision, false, handler, inputEncoding).
Parameters:
url - a URL of a text file that is to be annotated
Parameters:
pegRevision - a revision in which path is first looked upin the repository
Parameters:
startRevision - a revision for an operation to start from
Parameters:
endRevision - a revision for an operation to stop at
Parameters:
handler - a caller's handler to process annotation information
Parameters:
inputEncoding - a desired character set (encoding) of text lines
throws:
SVNException - |
| doAnnotate | | public void doAnnotate(SVNURL url, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean force, ISVNAnnotateHandler handler, String inputEncoding) throws SVNException(Code) | | Obtains annotation information for each file text line from a repository
and passes it to a provided annotation handler.
If startRevision is invalid (for example,
startRevision =
SVNRevision.UNDEFINED UNDEFINED ) then
it's set to revision 1.
If inputEncoding is null then
"file.encoding" system property is used.
Parameters:
url - a URL of a text file that is to be annotated
Parameters:
pegRevision - a revision in which path is first looked upin the repository
Parameters:
startRevision - a revision for an operation to start from
Parameters:
endRevision - a revision for an operation to stop at
Parameters:
force - forces operation to run (all files to be treated as text, no matter what SVNKit has inferred from the mime-type property)
Parameters:
handler - a caller's handler to process annotation information
Parameters:
inputEncoding - a desired character set (encoding) of text lines
throws:
SVNException -
since:
1.1 |
| doLog | | public void doLog(File[] paths, SVNRevision startRevision, SVNRevision endRevision, boolean stopOnCopy, boolean reportPaths, long limit, ISVNLogEntryHandler handler) throws SVNException(Code) | | 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.
If paths is not empty then the result will be restricted
to only those revisions from the specified range [startRevision, endRevision],
where paths were changed in the repository. To cover the
entire range set paths just to an empty array:
logClient.doLog(new File[]{""},..);
If startRevision is valid but endRevision is
not (for example, endRevision =
SVNRevision.UNDEFINED UNDEFINED )
then endRevision is equated to startRevision.
If startRevision is invalid (for example,
SVNRevision.UNDEFINED UNDEFINED )
then it's equated to
SVNRevision.BASE BASE . In this case if endRevision is
also invalid, then endRevision is set to revision 0.
Calling this method is equivalent to
doLog(paths, SVNRevision.UNDEFINED, startRevision, endRevision, stopOnCopy, reportPaths, limit, handler).
Parameters:
paths - an array of Working Copy paths,should not be null
Parameters:
startRevision - a revision for an operation to start from (includingthis revision)
Parameters:
endRevision - a revision for an operation to stop at (includingthis revision)
Parameters:
stopOnCopy - true not to crosscopies while traversing history, otherwise copies historywill be also included into processing
Parameters:
reportPaths - true to reportof all changed paths for every revision being processed (those paths will be available by calling org.tmatesoft.svn.core.SVNLogEntry.getChangedPaths)
Parameters:
limit - a maximum number of log entries to be processed
Parameters:
handler - 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 suchentry in the Working Copy
paths contain entries that belong todifferent repositories
See Also: SVNLogClient.doLog(SVNURL,String[],SVNRevision,SVNRevision,SVNRevision,boolean,boolean,long,ISVNLogEntryHandler)
See Also: |
| doLog | | public void doLog(File[] paths, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean stopOnCopy, boolean reportPaths, long limit, ISVNLogEntryHandler handler) throws SVNException(Code) | | 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.
If paths is not empty then the result will be restricted
to only those revisions from the specified range [startRevision, endRevision],
where paths were changed in the repository. To cover the
entire range set paths just to an empty array:
logClient.doLog(new File[]{""},..);
If startRevision is valid but endRevision is
not (for example, endRevision =
SVNRevision.UNDEFINED UNDEFINED )
then endRevision is equated to startRevision.
If startRevision is invalid (for example,
SVNRevision.UNDEFINED UNDEFINED )
then it's equated to
SVNRevision.BASE BASE . In this case if endRevision is
also invalid, then endRevision is set to revision 0.
Parameters:
paths - an array of Working Copy paths,should not be null
Parameters:
pegRevision - a revision in which path is first looked upin the repository
Parameters:
startRevision - a revision for an operation to start from (includingthis revision)
Parameters:
endRevision - a revision for an operation to stop at (includingthis revision)
Parameters:
stopOnCopy - true not to crosscopies while traversing history, otherwise copies historywill be also included into processing
Parameters:
reportPaths - true to reportof all changed paths for every revision being processed (those paths will be available by calling org.tmatesoft.svn.core.SVNLogEntry.getChangedPaths)
Parameters:
limit - a maximum number of log entries to be processed
Parameters:
handler - 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 suchentry in the Working Copy
paths contain entries that belong todifferent repositories
|
| doLog | | public void doLog(SVNURL url, String[] paths, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, boolean stopOnCopy, boolean reportPaths, long limit, ISVNLogEntryHandler handler) throws SVNException(Code) | | 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.
If paths is null or empty
then url is the target path that is used to restrict the result
to only those revisions from the specified range [startRevision, endRevision],
where url was changed in the repository. Otherwise if paths is
not empty then url is the root for all those paths (that are
used for restricting the result).
If startRevision is valid but endRevision is
not (for example, endRevision =
SVNRevision.UNDEFINED UNDEFINED )
then endRevision is equated to startRevision.
If startRevision is invalid (for example,
SVNRevision.UNDEFINED UNDEFINED )
then it's equated to
SVNRevision.HEAD HEAD . In this case if endRevision is
also invalid, then endRevision is set to revision 0.
Parameters:
url - a target URL
Parameters:
paths - an array of paths relative to the target url
Parameters:
pegRevision - a revision in which url is first looked up
Parameters:
startRevision - a revision for an operation to start from (includingthis revision)
Parameters:
endRevision - a revision for an operation to stop at (includingthis revision)
Parameters:
stopOnCopy - true not to crosscopies while traversing history, otherwise copies historywill be also included into processing
Parameters:
reportPaths - true to reportof all changed paths for every revision being processed (those paths will be available by calling org.tmatesoft.svn.core.SVNLogEntry.getChangedPaths)
Parameters:
limit - a maximum number of log entries to be processed
Parameters:
handler - a caller's log entry handler
throws:
SVNException -
See Also: SVNLogClient.doLog(File[],SVNRevision,SVNRevision,boolean,boolean,long,ISVNLogEntryHandler)
since:
1.1, new in Subversion 1.4 |
| getDiffOptions | | public SVNDiffOptions getDiffOptions()(Code) | | Gets the diff options that are used in annotate operations
by this client. Creates a new one if none was used before.
diff options |
| setDiffOptions | | public void setDiffOptions(SVNDiffOptions diffOptions)(Code) | | Sets diff options for this client to use in annotate operations.
Parameters:
diffOptions - diff options object |
| 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)
|
|
|