| java.lang.Object
 org.tmatesoft.svn.core.wc.SVNBasicClient
All known Subclasses: org.tmatesoft.svn.core.wc.admin.SVNAdminClient, org.tmatesoft.svn.core.wc.SVNLogClient, org.tmatesoft.svn.core.wc.admin.SVNLookClient, org.tmatesoft.svn.core.wc.SVNCopyClient, org.tmatesoft.svn.core.wc.SVNWCClient, org.tmatesoft.svn.core.wc.SVNUpdateClient, org.tmatesoft.svn.core.wc.SVNCommitClient, org.tmatesoft.svn.core.wc.SVNStatusClient, org.tmatesoft.svn.core.wc.SVNMoveClient, org.tmatesoft.svn.core.wc.SVNDiffClient,
| SVNBasicClient | | public class SVNBasicClient implements ISVNEventHandler(Code) | | The SVNBasicClient is the base class of all
SVN*Client classes that provides a common interface
and realization.
All of SVN*Client classes use inherited methods of
SVNBasicClient to access Working Copies metadata, to create
a driver object to access a repository if it's necessary, etc. In addition
SVNBasicClient provides some interface methods - such as those
that allow you to set your
ISVNEventHandler event handler ,
obtain run-time configuration options, and others.
version:
1.1.1
author:
TMate Software Ltd. |
| Inner Class :protected static class RepositoryReference | |
| Inner Class :protected static class SVNRepositoryLocation | |
| Method Summary | |
| public void | checkCancelled()
Redirects this call to the registered event handler (if any). | | protected SVNRepository | createRepository(SVNURL url, boolean mayReuse)
| | protected SVNRepository | createRepository(SVNURL url, File path, SVNRevision pegRevision, SVNRevision revision)
| | protected SVNRepository | createRepository(SVNURL url, File path, SVNRevision pegRevision, SVNRevision revision, long[] pegRev)
| | protected SVNWCAccess | createWCAccess()
| | protected SVNWCAccess | createWCAccess(String pathPrefix)
| | protected void | dispatchEvent(SVNEvent event)
| | protected void | dispatchEvent(SVNEvent event, double progress)
| | public ISVNDebugLog | getDebugLog()
Returns the debug logger currently in use. | | protected ISVNEventHandler | getEventDispatcher()
| | protected SVNRepositoryLocation[] | getLocations(SVNURL url, File path, SVNRepository repository, SVNRevision revision, SVNRevision start, SVNRevision end)
| | public ISVNOptions | getOptions()
Gets a run-time configuration area driver used by this object. | | protected ISVNRepositoryPool | getRepositoryPool()
| | protected long | getRevisionNumber(SVNRevision revision, SVNRepository repository, File path)
| | protected SVNURL | getURL(File path)
| | public void | handleEvent(SVNEvent event, double progress)
Dispatches events to the registered event handler (if any). | | public boolean | isIgnoreExternals()
Determines if externals definitions are ignored. | | public boolean | isLeaveConflictsUnresolved()
Determines if conflicted files should be left unresolved
preventing from merging their contents during update and merge
operations. | | public void | setDebugLog(ISVNDebugLog log)
Sets a logger to write debug log information to. | | public void | setEventHandler(ISVNEventHandler dispatcher)
Sets an event handler for this object. | | public void | setEventPathPrefix(String prefix)
Removes or adds a path prefix. | | public void | setIgnoreExternals(boolean ignore)
Sets externals definitions to be ignored or not during
operations. | | public void | setLeaveConflictsUnresolved(boolean leave)
Sets (or unsets) all conflicted working files to be untouched
by update and merge operations.
By default when a file receives changes from the repository
that are in conflict with local edits, an update operation places
two sections for each conflicting snatch into the working file
one of which is a user's local edit and the second is the one just
received from the repository. | | public void | setOptions(ISVNOptions options)
| | protected void | sleepForTimeStamp()
|
| getDebugLog | | public ISVNDebugLog getDebugLog()(Code) | | Returns the debug logger currently in use.
If no debug logger has been specified by the time this call occurs,
a default one (returned by org.tmatesoft.svn.util.SVNDebugLog.getDefaultLog())
will be created and used.
a debug logger |
| getOptions | | public ISVNOptions getOptions()(Code) | | Gets a run-time configuration area driver used by this object.
the run-time options driver being in use |
| handleEvent | | public void handleEvent(SVNEvent event, double progress) throws SVNException(Code) | | Dispatches events to the registered event handler (if any).
Parameters:
event - the current event
Parameters:
progress - progress state (from 0 to 1)
throws:
SVNException - |
| isLeaveConflictsUnresolved | | public boolean isLeaveConflictsUnresolved()(Code) | | Determines if conflicted files should be left unresolved
preventing from merging their contents during update and merge
operations.
true if conflicted filesare set to be prevented from merging, falseif there's no such restriction
See Also: SVNBasicClient.setLeaveConflictsUnresolved(boolean)
See Also: |
| setDebugLog | | public void setDebugLog(ISVNDebugLog log)(Code) | | Sets a logger to write debug log information to.
Parameters:
log - a debug logger |
| setEventHandler | | public void setEventHandler(ISVNEventHandler dispatcher)(Code) | | Sets an event handler for this object. This event handler
will be dispatched
SVNEvent objects to provide
detailed information about actions and progress state
of version control operations performed by do*()
methods of SVN*Client classes.
Parameters:
dispatcher - an event handler |
| setEventPathPrefix | | public void setEventPathPrefix(String prefix)(Code) | | Removes or adds a path prefix. This method is not intended for
users (from an API point of view).
Parameters:
prefix - a path prefix |
| setIgnoreExternals | | public void setIgnoreExternals(boolean ignore)(Code) | | Sets externals definitions to be ignored or not during
operations.
For example, if external definitions are set to be ignored
then a checkout operation won't fetch them into a Working Copy.
Parameters:
ignore - true to ignoreexternals definitions, false - not to
See Also: SVNBasicClient.isIgnoreExternals() |
| setLeaveConflictsUnresolved | | public void setLeaveConflictsUnresolved(boolean leave)(Code) | | Sets (or unsets) all conflicted working files to be untouched
by update and merge operations.
By default when a file receives changes from the repository
that are in conflict with local edits, an update operation places
two sections for each conflicting snatch into the working file
one of which is a user's local edit and the second is the one just
received from the repository. Like this:
<<<<<<< .mine
user's text
=======
received text
>>>>>>> .r2
Also the operation creates three temporary files that appear in the
same directory as the working file. Now if you call this method with
leave set to true,
an update will still create temporary files but won't place those two
sections into your working file. And this behaviour also concerns
merge operations: any merging to a conflicted file will be prevented.
In addition if there is any registered event
handler for an SVNDiffClient or SVNUpdateClient
instance then the handler will be dispatched an event with
the status type set to
SVNStatusType.CONFLICTED_UNRESOLVED .
The default value is false until
a caller explicitly changes it calling this method.
Parameters:
leave - true to prevent conflicted files from merging (all merging operations will be skipped), otherwise false
See Also: SVNBasicClient.isLeaveConflictsUnresolved()
See Also:
See Also: SVNUpdateClient
See Also: SVNDiffClient
See Also: ISVNEventHandler |
| sleepForTimeStamp | | protected void sleepForTimeStamp()(Code) | | |
|
|