org.tmatesoft.svn.core.wc
public class SVNBasicClient extends Object implements ISVNEventHandler
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 event handler
,
obtain run-time configuration options, and others.
Version: 1.1.1
Nested Class Summary | |
---|---|
protected static class | SVNBasicClient.RepositoryReference |
protected static class | SVNBasicClient.SVNRepositoryLocation |
Constructor Summary | |
---|---|
protected | SVNBasicClient(ISVNAuthenticationManager authManager, ISVNOptions options) |
protected | SVNBasicClient(ISVNRepositoryPool repositoryPool, ISVNOptions options) |
Method Summary | |
---|---|
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) |
ISVNDebugLog | getDebugLog()
Returns the debug logger currently in use.
|
protected ISVNEventHandler | getEventDispatcher() |
protected SVNBasicClient.SVNRepositoryLocation[] | getLocations(SVNURL url, File path, SVNRepository repository, SVNRevision revision, SVNRevision start, SVNRevision end) |
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) |
void | handleEvent(SVNEvent event, double progress)
Dispatches events to the registered event handler (if any).
|
boolean | isIgnoreExternals()
Determines if externals definitions are ignored.
|
boolean | isLeaveConflictsUnresolved()
Determines if conflicted files should be left unresolved
preventing from merging their contents during update and merge
operations.
|
void | setDebugLog(ISVNDebugLog log)
Sets a logger to write debug log information to.
|
void | setEventHandler(ISVNEventHandler dispatcher)
Sets an event handler for this object. |
void | setEventPathPrefix(String prefix)
Removes or adds a path prefix. |
void | setIgnoreExternals(boolean ignore)
Sets externals definitions to be ignored or not during
operations.
|
void | setLeaveConflictsUnresolved(boolean leave)
Sets (or unsets) all conflicted working files to be untouched
by update and merge operations.
|
void | setOptions(ISVNOptions options) |
protected void | sleepForTimeStamp() |
Throws: SVNCancelException if the current operation was cancelled
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.
Returns: a debug logger
Returns: the run-time options driver being in use
Parameters: event the current event progress progress state (from 0 to 1)
Throws: SVNException
Returns: true if ignored, otherwise false
See Also: SVNBasicClient
Returns: true if conflicted files are set to be prevented from merging, false if there's no such restriction
See Also: SVNBasicClient
Parameters: log a debug logger
Parameters: dispatcher an event handler
Parameters: prefix a path prefix
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 ignore externals definitions, false - not to
See Also: isIgnoreExternals
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
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 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: isLeaveConflictsUnresolved SVNUpdateClient SVNDiffClient ISVNEventHandler