Package org.tigris.subversion.javahl
Interface SVNClientInterface
- All Known Implementing Classes:
SVNClient
,SVNClientSynchronized
public interface SVNClientInterface
This interface is the commom interface for all subversion
operations. It is implemented by SVNClient and SVNClientSynchronized
-
Method Summary
Modifier and Type Method Description void
add(String path, boolean recurse)
Deprecated.Useadd(String, int, boolean, boolean, boolean)
instead.void
add(String path, boolean recurse, boolean force)
Deprecated.Useadd(String, int, boolean, boolean, boolean)
instead.void
add(String path, int depth, boolean force, boolean noIgnores, boolean addParents)
Adds a file to the repository.void
addToChangelist(String[] paths, String changelist, int depth, String[] changelists)
Add paths to a changelistbyte[]
blame(String path, Revision revisionStart, Revision revisionEnd)
Deprecated.void
blame(String path, Revision revisionStart, Revision revisionEnd, BlameCallback callback)
Deprecated.void
blame(String path, Revision pegRevision, Revision revisionStart, Revision revisionEnd, boolean ignoreMimeType, boolean includeMergedRevisions, BlameCallback2 callback)
Deprecated.void
blame(String path, Revision pegRevision, Revision revisionStart, Revision revisionEnd, boolean ignoreMimeType, boolean includeMergedRevisions, BlameCallback3 callback)
Retrieve the content together with the author, the revision and the date of the last change of each linevoid
blame(String path, Revision pegRevision, Revision revisionStart, Revision revisionEnd, BlameCallback callback)
Deprecated.void
cancelOperation()
cancel the active operationlong
checkout(String moduleName, String destPath, Revision revision, boolean recurse)
Deprecated.long
checkout(String moduleName, String destPath, Revision revision, Revision pegRevision, boolean recurse, boolean ignoreExternals)
Deprecated.long
checkout(String moduleName, String destPath, Revision revision, Revision pegRevision, int depth, boolean ignoreExternals, boolean allowUnverObstructions)
Executes a revision checkout.void
cleanup(String path)
Recursively cleans up a local directory, finishing any incomplete operations, removing lockfiles, etc.long
commit(String[] path, String message, boolean recurse)
Deprecated.Use#commit(String[], String, int, boolean, boolean, String[])
instead.long
commit(String[] path, String message, boolean recurse, boolean noUnlock)
Deprecated.Use#commit(String[], String, int, boolean, boolean, String[])
instead.long
commit(String[] path, String message, int depth, boolean noUnlock, boolean keepChangelist, String[] changelists, Map revpropTable)
Commits changes to the repository.void
commitMessageHandler(CommitMessage messageHandler)
Sets the commit message handler.void
copy(String srcPath, String destPath, String message, Revision revision)
Deprecated.void
copy(CopySource[] sources, String destPath, String message, boolean copyAsChild, boolean makeParents, boolean ignoreExternals, Map revpropTable)
Copy versioned paths with the history preserved.void
copy(CopySource[] sources, String destPath, String message, boolean copyAsChild, boolean makeParents, Map revpropTable)
Deprecated.void
diff(String target1, Revision revision1, String target2, Revision revision2, String outFileName, boolean recurse)
Deprecated.Use#diff(String, Revision, String, Revision, String, String, int, boolean, boolean, boolean)
instead.void
diff(String target1, Revision revision1, String target2, Revision revision2, String outFileName, boolean recurse, boolean ignoreAncestry, boolean noDiffDeleted, boolean force)
Deprecated.Use#diff(String, Revision, String, Revision, String, String, int, boolean, boolean, boolean)
instead.void
diff(String target1, Revision revision1, String target2, Revision revision2, String relativeToDir, String outFileName, int depth, String[] changelists, boolean ignoreAncestry, boolean noDiffDeleted, boolean force)
Deprecated.Use#diff(String, Revision, String, Revision, String, String, int, boolean, boolean, boolean, boolean)
instead.void
diff(String target1, Revision revision1, String target2, Revision revision2, String relativeToDir, String outFileName, int depth, String[] changelists, boolean ignoreAncestry, boolean noDiffDeleted, boolean force, boolean copiesAsAdds)
Display the differences between two pathsvoid
diff(String target, Revision pegRevision, Revision startRevision, Revision endRevision, String outFileName, boolean recurse, boolean ignoreAncestry, boolean noDiffDeleted, boolean force)
Deprecated.Use#diff(String, Revision, Revision, Revision, String, String, int, boolean, boolean, boolean)
instead.void
diff(String target, Revision pegRevision, Revision startRevision, Revision endRevision, String relativeToDir, String outFileName, int depth, String[] changelists, boolean ignoreAncestry, boolean noDiffDeleted, boolean force)
Deprecated.Use#diff(String, Revision, Revision, Revision, String, String, int, boolean, boolean, boolean, boolean)
instead.void
diff(String target, Revision pegRevision, Revision startRevision, Revision endRevision, String relativeToDir, String outFileName, int depth, String[] changelists, boolean ignoreAncestry, boolean noDiffDeleted, boolean force, boolean copiesAsAdds)
Display the differences between two paths.void
diffSummarize(String target1, Revision revision1, String target2, Revision revision2, int depth, String[] changelists, boolean ignoreAncestry, DiffSummaryReceiver receiver)
Produce a diff summary which lists the items changed between path and revision pairs.void
diffSummarize(String target, Revision pegRevision, Revision startRevision, Revision endRevision, int depth, String[] changelists, boolean ignoreAncestry, DiffSummaryReceiver receiver)
Produce a diff summary which lists the items changed between path and revision pairs.void
dispose()
release the native peer (should not depend on finalize)long
doExport(String srcPath, String destPath, Revision revision, boolean force)
Deprecated.long
doExport(String srcPath, String destPath, Revision revision, Revision pegRevision, boolean force, boolean ignoreExternals, boolean recurse, String nativeEOL)
Deprecated.long
doExport(String srcPath, String destPath, Revision revision, Revision pegRevision, boolean force, boolean ignoreExternals, int depth, String nativeEOL)
Exports the contents of either a subversion repository into a 'clean' directory (meaning a directory with no administrative directories).void
doImport(String path, String url, String message, boolean recurse)
Deprecated.Use#doImport(String, String, String, int, boolean, boolean)
instead.void
doImport(String path, String url, String message, int depth, boolean noIgnore, boolean ignoreUnknownNodeTypes, Map revpropTable)
Import a file or directory into a repository directory at head.long
doSwitch(String path, String url, Revision revision, boolean recurse)
Deprecated.UsedoSwitch(String, String, Revision, boolean)
instead.long
doSwitch(String path, String url, Revision revision, Revision pegRevision, int depth, boolean depthIsSticky, boolean ignoreExternals, boolean allowUnverObstructions)
Update local copy to mirror a new url.byte[]
fileContent(String path, Revision revision)
Deprecated.UsefileContent(String, Revision, Revision)
instead.byte[]
fileContent(String path, Revision revision, Revision pegRevision)
Retrieve the content of a fileString
getAdminDirectoryName()
void
getChangelists(String rootPath, String[] changelists, int depth, ChangelistCallback callback)
Recursively get the paths which belong to a changelistString
getConfigDirectory()
Get the configuration directoryString
getLastPath()
Deprecated.Mergeinfo
getMergeinfo(String path, Revision pegRevision)
Get mergeinfo forpath
atpegRevision
.void
getMergeinfoLog(int kind, String pathOrUrl, Revision pegRevision, String mergeSourceUrl, Revision srcPegRevision, boolean discoverChangedPaths, int depth, String[] revProps, LogMessageCallback callback)
Retrieve either merged or eligible-to-be-merged revisions.void
getMergeinfoLog(int kind, String pathOrUrl, Revision pegRevision, String mergeSourceUrl, Revision srcPegRevision, boolean discoverChangedPaths, String[] revProps, LogMessageCallback callback)
Version
getVersion()
String
getVersionInfo(String path, String trailUrl, boolean lastChanged)
Produce a compact "version number" for a working copyInfo
info(String path)
Deprecated.Use#info2(String, Revision, Revision, int, InfoCallback)
instead.Info2[]
info2(String pathOrUrl, Revision revision, Revision pegRevision, boolean recurse)
Deprecated.Use#info2(String, Revision, Revision, int, InfoCallback)
instead.void
info2(String pathOrUrl, Revision revision, Revision pegRevision, int depth, String[] changelists, InfoCallback callback)
Retrieve information about repository or working copy items.boolean
isAdminDirectory(String name)
DirEntry[]
list(String url, Revision revision, boolean recurse)
Deprecated.DirEntry[]
list(String url, Revision revision, Revision pegRevision, boolean recurse)
Deprecated.void
list(String url, Revision revision, Revision pegRevision, int depth, int direntFields, boolean fetchLocks, ListCallback callback)
Lists the directory entries of a url on the server.void
lock(String[] path, String comment, boolean force)
Lock a working copy itemLogMessage[]
logMessages(String path, Revision revisionStart, Revision revisionEnd)
LogMessage[]
logMessages(String path, Revision revisionStart, Revision revisionEnd, boolean stopOnCopy)
LogMessage[]
logMessages(String path, Revision revisionStart, Revision revisionEnd, boolean stopOnCopy, boolean discoverPath)
LogMessage[]
logMessages(String path, Revision revisionStart, Revision revisionEnd, boolean stopOnCopy, boolean discoverPath, long limit)
void
logMessages(String path, Revision pegRevision, RevisionRange[] ranges, boolean stopOnCopy, boolean discoverPath, boolean includeMergedRevisions, String[] revProps, long limit, LogMessageCallback callback)
Retrieve the log messages for an item.void
logMessages(String path, Revision pegRevision, Revision revisionStart, Revision revisionEnd, boolean stopOnCopy, boolean discoverPath, boolean includeMergedRevisions, String[] revProps, long limit, LogMessageCallback callback)
void
merge(String path1, Revision revision1, String path2, Revision revision2, String localPath, boolean force, boolean recurse)
Deprecated.void
merge(String path1, Revision revision1, String path2, Revision revision2, String localPath, boolean force, boolean recurse, boolean ignoreAncestry, boolean dryRun)
Deprecated.void
merge(String path1, Revision revision1, String path2, Revision revision2, String localPath, boolean force, int depth, boolean ignoreAncestry, boolean dryRun, boolean recordOnly)
Merge changes from two paths into a new local path.void
merge(String path, Revision pegRevision, RevisionRange[] revisions, String localPath, boolean force, int depth, boolean ignoreAncestry, boolean dryRun, boolean recordOnly)
Merge set of revisions into a new local path.void
merge(String path, Revision pegRevision, Revision revision1, Revision revision2, String localPath, boolean force, boolean recurse, boolean ignoreAncestry, boolean dryRun)
Deprecated.void
mergeReintegrate(String path, Revision pegRevision, String localPath, boolean dryRun)
Perform a reintegration merge of path into localPath.void
mkdir(String[] path, String message)
Creates a directory directly in a repository or creates a directory on disk and schedules it for addition.void
mkdir(String[] path, String message, boolean makeParents, Map revpropTable)
Creates a directory directly in a repository or creates a directory on disk and schedules it for addition.void
move(String[] srcPaths, String destPath, String message, boolean force, boolean moveAsChild, boolean makeParents, Map revpropTable)
Move or rename versioned paths.void
move(String srcPath, String destPath, String message, boolean force)
Deprecated.Use#move(String[], String, String, boolean, boolean, boolean)
instead.void
move(String srcPath, String destPath, String message, Revision ignored, boolean force)
Deprecated.Use#move(String[], String, String, boolean, boolean, boolean)
instead.void
notification(Notify notify)
Deprecated.Usenotification2(Notify2)
instead.void
notification2(Notify2 notify)
Sets the notification callback used to send processing information back to the calling program.void
password(String password)
Sets the password used for authentication.PropertyData[]
properties(String path)
Deprecated.Use#properties(String, Revision, Revision, int, ProplistCallback)
instead.PropertyData[]
properties(String path, Revision revision)
Deprecated.Use#properties(String, Revision, Revision, int, ProplistCallback)
instead.PropertyData[]
properties(String path, Revision revision, Revision pegRevision)
Deprecated.Use#properties(String, Revision, Revision, int, ProplistCallback)
instead.void
properties(String path, Revision revision, Revision pegRevision, int depth, String[] changelists, ProplistCallback callback)
Retrieves the properties of an itemvoid
propertyCreate(String path, String name, byte[] value, boolean recurse)
Deprecated.Use#propertyCreate(String, String, String, int, boolean)
instead.void
propertyCreate(String path, String name, byte[] value, boolean recurse, boolean force)
Deprecated.Use#propertyCreate(String, String, String, int, boolean)
instead.void
propertyCreate(String path, String name, String value, boolean recurse)
Deprecated.Use#propertyCreate(String, String, String, int, boolean)
instead.void
propertyCreate(String path, String name, String value, boolean recurse, boolean force)
Deprecated.Use#propertyCreate(String, String, String, int, boolean)
instead.void
propertyCreate(String path, String name, String value, int depth, String[] changelists, boolean force)
Create and sets one property of an item with a byte array valuePropertyData
propertyGet(String path, String name)
Deprecated.UsepropertyGet(String, String, Revision)
instead.PropertyData
propertyGet(String path, String name, Revision revision)
Retrieve one property of one itemPropertyData
propertyGet(String path, String name, Revision revision, Revision pegRevision)
Retrieve one property of one itemvoid
propertyRemove(String path, String name, boolean recurse)
Deprecated.Use#propertyRemove(String, String, int)
instead.void
propertyRemove(String path, String name, int depth, String[] changelists)
Remove one property of an item.void
propertySet(String path, String name, byte[] value, boolean recurse)
Deprecated.Use#propertySet(String, String, String, int, boolean)
instead.void
propertySet(String path, String name, byte[] value, boolean recurse, boolean force)
Deprecated.Use#propertySet(String, String, String, int, boolean)
instead.void
propertySet(String path, String name, String value, boolean recurse)
Deprecated.Use#propertySet(String, String, String, int, boolean)
instead.void
propertySet(String path, String name, String value, boolean recurse, boolean force)
Deprecated.Use#propertySet(String, String, String, int, boolean)
instead.void
propertySet(String path, String name, String value, int depth, String[] changelists, boolean force, Map revpropTable)
Sets one property of an item with a String valuevoid
relocate(String from, String to, String path, boolean recurse)
Rewrite the url's in the working copyvoid
remove(String[] path, String message, boolean force)
Deprecated.Use#remove(String[], String, boolean, boolean)
instead.void
remove(String[] path, String message, boolean force, boolean keepLocal, Map revpropTable)
Sets a file for deletion.void
removeFromChangelists(String[] paths, int depth, String[] changelists)
Remove paths from a changelistvoid
resolve(String path, int depth, int conflictResult)
Resolves the conflicted state on a WC path (or tree).void
resolved(String path, boolean recurse)
Deprecated.Use#resolved(String, int, int)
instead.void
revert(String path, boolean recurse)
Deprecated.Use#revert(String, int)
instead.void
revert(String path, int depth, String[] changelists)
Reverts a file to a pristine state.PropertyData[]
revProperties(String path, Revision rev)
Retrieve all revsision properties of one itemPropertyData
revProperty(String path, String name, Revision rev)
Retrieve one revsision property of one itemvoid
setConfigDirectory(String configDir)
Set directory for the configuration information, taking the usual steps to ensure that Subversion's config file templates exist in the specified location..void
setConflictResolver(ConflictResolverCallback listener)
Set the conflict resolution callback.void
setProgressListener(ProgressListener listener)
Set the progress callback.void
setPrompt(PromptUserPassword prompt)
Register callback interface to supply username and password on demand.void
setRevProperty(String path, String name, Revision rev, String value, boolean force)
set one revsision property of one itemvoid
setRevProperty(String path, String name, Revision rev, String value, String originalValue, boolean force)
set one revsision property of one itemStatus
singleStatus(String path, boolean onServer)
Deprecated.Use#status(String, int, boolean, boolean, boolean, boolean, StatusCallback)
instead.Status[]
status(String path, boolean descend, boolean onServer, boolean getAll)
Deprecated.Use#status(String, int, boolean, boolean, boolean, boolean, StatusCallback)
instead.Status[]
status(String path, boolean descend, boolean onServer, boolean getAll, boolean noIgnore)
Deprecated.Use#status(String, int, boolean, boolean, boolean, boolean, StatusCallback)
instead.Status[]
status(String path, boolean descend, boolean onServer, boolean getAll, boolean noIgnore, boolean ignoreExternals)
Deprecated.Use#status(String, int, boolean, boolean, boolean, boolean, StatusCallback)
instead.void
status(String path, int depth, boolean onServer, boolean getAll, boolean noIgnore, boolean ignoreExternals, String[] changelists, StatusCallback callback)
List a directory or file of the working copy.void
streamFileContent(String path, Revision revision, Revision pegRevision, int bufferSize, OutputStream stream)
Write the file's content to the specified output stream.String[]
suggestMergeSources(String path, Revision pegRevision)
Return an ordered list of suggested merge source URLs.void
unlock(String[] path, boolean force)
Unlock a working copy itemlong[]
update(String[] path, Revision revision, boolean recurse, boolean ignoreExternals)
Deprecated.long[]
update(String[] path, Revision revision, int depth, boolean depthIsSticky, boolean ignoreExternals, boolean allowUnverObstructions)
Updates the directories or files from repositorylong
update(String path, Revision revision, boolean recurse)
Deprecated.long
update(String path, Revision revision, int depth, boolean depthIsSticky, boolean ignoreExternals, boolean allowUnverObstructions)
Updates the directory or file from repositoryvoid
upgrade(String path)
Recursively upgrade a working copy to a new metadata storage format.void
username(String username)
Sets the username used for authentication.
-
Method Details
-
dispose
void dispose()release the native peer (should not depend on finalize) -
getVersion
Version getVersion()- Returns:
- Version information about the underlying native libraries.
- Since:
- 1.0
-
getAdminDirectoryName
String getAdminDirectoryName()- Returns:
- The name of the working copy's administrative
directory, which is usually
.svn
. - Since:
- 1.3
- See Also:
- Instructions on changing this as a work-around for the behavior of ASP.Net on Windows.
-
isAdminDirectory
- Parameters:
name
- The name of the directory to compare.- Returns:
- Whether
name
is that of a working copy administrative directory. - Since:
- 1.3
-
getLastPath
String getLastPath()Deprecated.Returns the last destination path submitted.- Returns:
- path in Subversion format.
- Since:
- 1.0
-
singleStatus
Deprecated.Use#status(String, int, boolean, boolean, boolean, boolean, StatusCallback)
instead.Returns the status of a single file in the path.- Parameters:
path
- File to gather status.onServer
- Request status information from the server.- Returns:
- The Subversion status of the file, or
null
if no status is available. - Throws:
ClientException
- Since:
- 1.0
-
status
Status[] status(String path, boolean descend, boolean onServer, boolean getAll) throws ClientExceptionDeprecated.Use#status(String, int, boolean, boolean, boolean, boolean, StatusCallback)
instead.List a directory or file of the working copy.- Parameters:
path
- Path to explore.descend
- Recurse into subdirectories if they exist.onServer
- Request status information from server.getAll
- get status for uninteresting (unchanged) files.- Returns:
- Array of Status entries.
- Throws:
ClientException
- Since:
- 1.0
-
status
Status[] status(String path, boolean descend, boolean onServer, boolean getAll, boolean noIgnore) throws ClientExceptionDeprecated.Use#status(String, int, boolean, boolean, boolean, boolean, StatusCallback)
instead.List a directory or file of the working copy.- Parameters:
path
- Path to explore.descend
- Recurse into subdirectories if they exist.onServer
- Request status information from server.getAll
- get status for uninteresting (unchanged) files.noIgnore
- get status for normaly ignored files and directories.- Returns:
- Array of Status entries.
- Throws:
ClientException
- Since:
- 1.0
-
status
Status[] status(String path, boolean descend, boolean onServer, boolean getAll, boolean noIgnore, boolean ignoreExternals) throws ClientExceptionDeprecated.Use#status(String, int, boolean, boolean, boolean, boolean, StatusCallback)
instead.List a directory or file of the working copy.- Parameters:
path
- Path to explore.descend
- Recurse into subdirectories if they exist.onServer
- Request status information from server.getAll
- get status for uninteresting (unchanged) files.noIgnore
- get status for normaly ignored files and directories.ignoreExternals
- if externals are ignored during status- Returns:
- Array of Status entries.
- Throws:
ClientException
- Since:
- 1.2
-
status
void status(String path, int depth, boolean onServer, boolean getAll, boolean noIgnore, boolean ignoreExternals, String[] changelists, StatusCallback callback) throws ClientExceptionList a directory or file of the working copy.- Parameters:
path
- Path to explore.depth
- How deep to recurse into subdirectories.onServer
- Request status information from server.getAll
- get status for uninteresting (unchanged) files.noIgnore
- get status for normaly ignored files and directories.ignoreExternals
- if externals are ignored during statuschangelists
- changelists to filter by- Throws:
ClientException
- Since:
- 1.5
-
list
Deprecated.Lists the directory entries of a url on the server.- Parameters:
url
- the url to listrevision
- the revision to listrecurse
- recurse into subdirectories- Returns:
- Array of DirEntry objects.
- Throws:
ClientException
- Since:
- 1.0
-
list
DirEntry[] list(String url, Revision revision, Revision pegRevision, boolean recurse) throws ClientExceptionDeprecated.Lists the directory entries of a url on the server.- Parameters:
url
- the url to listrevision
- the revision to listpegRevision
- the revision to interpret urlrecurse
- recurse into subdirectories- Returns:
- Array of DirEntry objects.
- Throws:
ClientException
- Since:
- 1.2
-
list
void list(String url, Revision revision, Revision pegRevision, int depth, int direntFields, boolean fetchLocks, ListCallback callback) throws ClientExceptionLists the directory entries of a url on the server.- Parameters:
url
- the url to listrevision
- the revision to listpegRevision
- the revision to interpret urldepth
- the depth to recurse into subdirectoriesdirentFields
- the fields to retrievefetchLocks
- whether to fetch lock informationcallback
- the callback to receive the directory entries- Throws:
ClientException
- Since:
- 1.5
-
username
Sets the username used for authentication.- Parameters:
username
- The username, ignored if the empty string. Set to the empty string to clear it.- Throws:
IllegalArgumentException
- Ifusername
isnull
.- Since:
- 1.0
- See Also:
password(String)
-
password
Sets the password used for authentication.- Parameters:
password
- The password, ignored if the empty string. Set to the empty string to clear it.- Throws:
IllegalArgumentException
- Ifpassword
isnull
.- Since:
- 1.0
- See Also:
username(String)
-
setPrompt
Register callback interface to supply username and password on demand. This callback can also be used to provide theequivalent of the--no-auth-cache
and--non-interactive
arguments accepted by the command-line client.- Parameters:
prompt
- the callback interface- Since:
- 1.0
-
logMessages
LogMessage[] logMessages(String path, Revision revisionStart, Revision revisionEnd) throws ClientExceptionDeprecated.Retrieve the log messages for an item- Parameters:
path
- path or url to get the log message for.revisionStart
- first revision to showrevisionEnd
- last revision to show- Returns:
- array of LogMessages
- Throws:
ClientException
- Since:
- 1.0
-
logMessages
LogMessage[] logMessages(String path, Revision revisionStart, Revision revisionEnd, boolean stopOnCopy) throws ClientExceptionDeprecated.Retrieve the log messages for an item- Parameters:
path
- path or url to get the log message for.revisionStart
- first revision to showrevisionEnd
- last revision to showstopOnCopy
- do not continue on copy operations- Returns:
- array of LogMessages
- Throws:
ClientException
- Since:
- 1.0
-
logMessages
LogMessage[] logMessages(String path, Revision revisionStart, Revision revisionEnd, boolean stopOnCopy, boolean discoverPath) throws ClientExceptionDeprecated.Retrieve the log messages for an item- Parameters:
path
- path or url to get the log message for.revisionStart
- first revision to showrevisionEnd
- last revision to showstopOnCopy
- do not continue on copy operationsdiscoverPath
- returns the paths of the changed items in the returned objects- Returns:
- array of LogMessages
- Throws:
ClientException
- Since:
- 1.0
-
logMessages
LogMessage[] logMessages(String path, Revision revisionStart, Revision revisionEnd, boolean stopOnCopy, boolean discoverPath, long limit) throws ClientExceptionDeprecated.Retrieve the log messages for an item- Parameters:
path
- path or url to get the log message for.revisionStart
- first revision to showrevisionEnd
- last revision to showstopOnCopy
- do not continue on copy operationsdiscoverPath
- returns the paths of the changed items in the returned objectslimit
- limit the number of log messages (if 0 or less no limit)- Returns:
- array of LogMessages
- Throws:
ClientException
- Since:
- 1.2
-
logMessages
void logMessages(String path, Revision pegRevision, Revision revisionStart, Revision revisionEnd, boolean stopOnCopy, boolean discoverPath, boolean includeMergedRevisions, String[] revProps, long limit, LogMessageCallback callback) throws ClientExceptionDeprecated.Retrieve the log messages for an item.- Parameters:
path
- path or url to get the log message for.pegRevision
- revision to interpret pathrevisionStart
- first revision to showrevisionEnd
- last revision to showstopOnCopy
- do not continue on copy operationsdiscoverPath
- returns the paths of the changed items in the returned objectsincludeMergedRevisions
- include log messages for revisions which were merged.revProps
- the revprops to retrievelimit
- limit the number of log messages (if 0 or less no limit)callback
- the object to receive the log messages- Throws:
ClientException
- Since:
- 1.5
-
logMessages
void logMessages(String path, Revision pegRevision, RevisionRange[] ranges, boolean stopOnCopy, boolean discoverPath, boolean includeMergedRevisions, String[] revProps, long limit, LogMessageCallback callback) throws ClientExceptionRetrieve the log messages for an item.- Parameters:
path
- path or url to get the log message for.pegRevision
- revision to interpret pathranges
- an array of revision ranges to showstopOnCopy
- do not continue on copy operationsdiscoverPath
- returns the paths of the changed items in the returned objectsincludeMergedRevisions
- include log messages for revisions which were merged.revProps
- the revprops to retrievelimit
- limit the number of log messages (if 0 or less no limit)callback
- the object to receive the log messages- Throws:
ClientException
- Since:
- 1.6
-
checkout
long checkout(String moduleName, String destPath, Revision revision, boolean recurse) throws ClientExceptionDeprecated.Executes a revision checkout.- Parameters:
moduleName
- name of the module to checkout.destPath
- destination directory for checkout.revision
- the revision to checkout.recurse
- whether you want it to checkout files recursively.- Throws:
ClientException
- Since:
- 1.0
-
checkout
long checkout(String moduleName, String destPath, Revision revision, Revision pegRevision, boolean recurse, boolean ignoreExternals) throws ClientExceptionDeprecated.Executes a revision checkout.- Parameters:
moduleName
- name of the module to checkout.destPath
- destination directory for checkout.revision
- the revision to checkout.pegRevision
- the peg revision to interpret the pathrecurse
- whether you want it to checkout files recursively.ignoreExternals
- if externals are ignored during checkout- Throws:
ClientException
- Since:
- 1.2
-
checkout
long checkout(String moduleName, String destPath, Revision revision, Revision pegRevision, int depth, boolean ignoreExternals, boolean allowUnverObstructions) throws ClientExceptionExecutes a revision checkout.- Parameters:
moduleName
- name of the module to checkout.destPath
- destination directory for checkout.revision
- the revision to checkout.pegRevision
- the peg revision to interpret the pathdepth
- how deep to checkout files recursively.ignoreExternals
- if externals are ignored during checkoutallowUnverObstructions
- allow unversioned paths that obstruct adds- Throws:
ClientException
- Since:
- 1.5
-
notification
Deprecated.Usenotification2(Notify2)
instead.Sets the notification callback used to send processing information back to the calling program.- Parameters:
notify
- listener that the SVN library should call on many file operations.- Since:
- 1.0
-
notification2
Sets the notification callback used to send processing information back to the calling program.- Parameters:
notify
- listener that the SVN library should call on many file operations.- Since:
- 1.2
-
setConflictResolver
Set the conflict resolution callback.- Parameters:
listener
- The conflict resolution callback.- Since:
- 1.5
-
setProgressListener
Set the progress callback.- Parameters:
listener
- The progress callback.- Since:
- 1.5
-
commitMessageHandler
Sets the commit message handler. This allows more complex commit message with the list of the elements to be committed as input.- Parameters:
messageHandler
- callback for entering commit messages if this is set the message parameter is ignored.- Since:
- 1.0
-
remove
Deprecated.Use#remove(String[], String, boolean, boolean)
instead.Sets a file for deletion.- Parameters:
path
- path or url to be deletedmessage
- if path is a url, this will be the commit message.force
- delete even when there are local modifications.- Throws:
ClientException
- Since:
- 1.0
-
remove
void remove(String[] path, String message, boolean force, boolean keepLocal, Map revpropTable) throws ClientExceptionSets a file for deletion.- Parameters:
path
- path or url to be deletedmessage
- if path is a url, this will be the commit message.force
- delete even when there are local modifications.keepLocal
- only remove the paths from the repository.revpropTable
- A string-to-string mapping of revision properties to values which will be set if this operation results in a commit.- Throws:
ClientException
- Since:
- 1.5
-
revert
Deprecated.Use#revert(String, int)
instead.Reverts a file to a pristine state.- Parameters:
path
- path of the file.recurse
- recurse into subdirectories- Throws:
ClientException
- Since:
- 1.0
-
revert
Reverts a file to a pristine state.- Parameters:
path
- path of the file.depth
- the depth to recurse into subdirectorieschangelists
- changelists to filter by- Throws:
ClientException
- Since:
- 1.5
-
add
Deprecated.Useadd(String, int, boolean, boolean, boolean)
instead.Adds a file to the repository.- Parameters:
path
- path to be added.recurse
- recurse into subdirectories- Throws:
ClientException
- Since:
- 1.0
-
add
Deprecated.Useadd(String, int, boolean, boolean, boolean)
instead.Adds a file to the repository.- Parameters:
path
- path to be added.recurse
- recurse into subdirectoriesforce
- if adding a directory and recurse true and path is a directory, all not already managed files are added.- Throws:
ClientException
- Since:
- 1.2
-
add
void add(String path, int depth, boolean force, boolean noIgnores, boolean addParents) throws ClientExceptionAdds a file to the repository.- Parameters:
path
- path to be added.depth
- the depth to recurse into subdirectoriesforce
- if adding a directory and recurse true and path is a directory, all not already managed files are added.noIgnores
- if false, don't add files or directories matching ignore patternsaddParents
- add any intermediate parents to the working copy- Throws:
ClientException
- Since:
- 1.5
-
update
Deprecated.Updates the directory or file from repository- Parameters:
path
- target file.revision
- the revision number to update. Revision.HEAD will update to the latest revision.recurse
- recursively update.- Throws:
ClientException
- Since:
- 1.0
-
update
long[] update(String[] path, Revision revision, boolean recurse, boolean ignoreExternals) throws ClientExceptionDeprecated.Updates the directories or files from repository- Parameters:
path
- array of target files.revision
- the revision number to update. Revision.HEAD will update to the latest revision.recurse
- recursively update.ignoreExternals
- if externals are ignored during update- Throws:
ClientException
- Since:
- 1.2
-
update
long update(String path, Revision revision, int depth, boolean depthIsSticky, boolean ignoreExternals, boolean allowUnverObstructions) throws ClientExceptionUpdates the directory or file from repository- Parameters:
path
- target file.revision
- the revision number to update. Revision.HEAD will update to the latest revision.depth
- the depth to recursively update.depthIsSticky
- if set, and depth is notDepth.unknown
, then also set the ambient depth value to depth.ignoreExternals
- if externals are ignored during updateallowUnverObstructions
- allow unversioned paths that obstruct adds- Throws:
ClientException
- Since:
- 1.5
-
update
long[] update(String[] path, Revision revision, int depth, boolean depthIsSticky, boolean ignoreExternals, boolean allowUnverObstructions) throws ClientExceptionUpdates the directories or files from repository- Parameters:
path
- array of target files.revision
- the revision number to update. Revision.HEAD will update to the latest revision.depth
- the depth to recursively update.depthIsSticky
- if set, and depth is notDepth.unknown
, then also set the ambient depth value to depth.ignoreExternals
- if externals are ignored during updateallowUnverObstructions
- allow unversioned paths that obstruct adds- Throws:
ClientException
- Since:
- 1.5
-
commit
Deprecated.Use#commit(String[], String, int, boolean, boolean, String[])
instead.Commits changes to the repository.- Parameters:
path
- files to commit.message
- log message.recurse
- whether the operation should be done recursively.- Returns:
- The new revision number created by the commit, or
Revision.SVN_INVALID_REVNUM
if the revision number is invalid. - Throws:
ClientException
-
commit
long commit(String[] path, String message, boolean recurse, boolean noUnlock) throws ClientExceptionDeprecated.Use#commit(String[], String, int, boolean, boolean, String[])
instead.Commits changes to the repository.- Parameters:
path
- files to commit.message
- log message.recurse
- whether the operation should be done recursively.noUnlock
- do remove any locks- Returns:
- The new revision number created by the commit, or
Revision.SVN_INVALID_REVNUM
if the revision number is invalid. - Throws:
ClientException
- Since:
- 1.2
-
commit
long commit(String[] path, String message, int depth, boolean noUnlock, boolean keepChangelist, String[] changelists, Map revpropTable) throws ClientExceptionCommits changes to the repository.- Parameters:
path
- files to commit.message
- log message.depth
- how deep to recurse in subdirectoriesnoUnlock
- do remove any lockskeepChangelist
- keep changelist associations after the commit.changelists
- if non-null, filter paths using changelistsrevpropTable
- A string-to-string mapping of revision properties to values which will be set if this operation results in a commit.- Returns:
- The new revision number created by the commit, or
Revision.SVN_INVALID_REVNUM
if the revision number is invalid. - Throws:
ClientException
- Since:
- 1.5
-
copy
void copy(CopySource[] sources, String destPath, String message, boolean copyAsChild, boolean makeParents, boolean ignoreExternals, Map revpropTable) throws ClientExceptionCopy versioned paths with the history preserved.- Parameters:
sources
- A list ofCopySource
objects.destPath
- Destination path or URL.message
- Commit message. May benull
ifdestPath
is not a URL.copyAsChild
- Whether to copysrcPaths
as children ofdestPath
.makeParents
- Whether to create intermediate parentsignoreExternals
- Whether or not to process external definitions as part of this operation.revpropTable
- A string-to-string mapping of revision properties to values which will be set if this operation results in a commit.- Throws:
ClientException
- If the copy operation fails.- Since:
- 1.7
-
copy
void copy(CopySource[] sources, String destPath, String message, boolean copyAsChild, boolean makeParents, Map revpropTable) throws ClientExceptionDeprecated.Copy versioned paths with the history preserved.- Parameters:
sources
- A list ofCopySource
objects.destPath
- Destination path or URL.message
- Commit message. May benull
ifdestPath
is not a URL.copyAsChild
- Whether to copysrcPaths
as children ofdestPath
.makeParents
- Whether to create intermediate parentsrevpropTable
- A string-to-string mapping of revision properties to values which will be set if this operation results in a commit.- Throws:
ClientException
- If the copy operation fails.- Since:
- 1.5
-
copy
void copy(String srcPath, String destPath, String message, Revision revision) throws ClientExceptionDeprecated.Copy versioned paths with the history preserved (withcopyAsChild
behavior).- Parameters:
srcPath
- source path or urldestPath
- destination path or urlmessage
- commit message if destPath is a urlrevision
- source revision- Throws:
ClientException
-
move
void move(String[] srcPaths, String destPath, String message, boolean force, boolean moveAsChild, boolean makeParents, Map revpropTable) throws ClientExceptionMove or rename versioned paths.- Parameters:
srcPaths
- Source paths or URLs.destPath
- Destination path or URL.message
- Commit message. May benull
ifdestPath
is not a URL.force
- Whether to perform the move even if local modifications exist.moveAsChild
- Whether to movesrcPaths
as children ofdestPath
.makeParents
- Whether to create intermediate parents.revpropTable
- A string-to-string mapping of revision properties to values which will be set if this operation results in a commit.- Throws:
ClientException
- If the move operation fails.- Since:
- 1.5
-
move
void move(String srcPath, String destPath, String message, Revision ignored, boolean force) throws ClientExceptionDeprecated.Use#move(String[], String, String, boolean, boolean, boolean)
instead.- Throws:
ClientException
- Since:
- 1.2
-
move
Deprecated.Use#move(String[], String, String, boolean, boolean, boolean)
instead.Move or rename versioned paths (withmoveAsChild
behavior).- Parameters:
srcPath
- source path or urldestPath
- destination path or urlmessage
- commit message if destPath is a urlforce
- even with local modifications.- Throws:
ClientException
- Since:
- 1.2
-
mkdir
void mkdir(String[] path, String message, boolean makeParents, Map revpropTable) throws ClientExceptionCreates a directory directly in a repository or creates a directory on disk and schedules it for addition.- Parameters:
path
- directories to be createdmessage
- commit message to used if path contains urlsmakeParents
- Whether to create intermediate parentsrevpropTable
- A string-to-string mapping of revision properties to values which will be set if this operation results in a commit.- Throws:
ClientException
- Since:
- 1.5
-
mkdir
Creates a directory directly in a repository or creates a directory on disk and schedules it for addition.- Parameters:
path
- directories to be createdmessage
- commit message to used if path contains urls- Throws:
ClientException
-
cleanup
Recursively cleans up a local directory, finishing any incomplete operations, removing lockfiles, etc.- Parameters:
path
- a local directory.- Throws:
ClientException
-
resolve
Resolves the conflicted state on a WC path (or tree).- Parameters:
path
- The path to resolve.depth
- How deep to recurse into child paths.conflictResult
- Which version to choose in the event of a conflict.- Throws:
SubversionException
- If an error occurs.- Since:
- 1.5
-
resolved
Deprecated.Use#resolved(String, int, int)
instead.Removes the conflicted state on a WC path (or tree).- Throws:
ClientException
- See Also:
#resolved(String, int, int)
-
doExport
long doExport(String srcPath, String destPath, Revision revision, boolean force) throws ClientExceptionDeprecated.Exports the contents of either a subversion repository into a 'clean' directory (meaning a directory with no administrative directories).- Parameters:
srcPath
- the url of the repository path to be exporteddestPath
- a destination path that must not already exist.revision
- the revsion to be exportedforce
- set if it is ok to overwrite local files- Throws:
ClientException
- Since:
- 1.0
-
doExport
long doExport(String srcPath, String destPath, Revision revision, Revision pegRevision, boolean force, boolean ignoreExternals, boolean recurse, String nativeEOL) throws ClientExceptionDeprecated.Exports the contents of either a subversion repository into a 'clean' directory (meaning a directory with no administrative directories).- Parameters:
srcPath
- the url of the repository path to be exporteddestPath
- a destination path that must not already exist.revision
- the revsion to be exportedpegRevision
- the revision to interpret srcPathforce
- set if it is ok to overwrite local filesignoreExternals
- ignore external during exportrecurse
- recurse to subdirectoriesnativeEOL
- which EOL characters to use during export- Throws:
ClientException
- Since:
- 1.2
-
doExport
long doExport(String srcPath, String destPath, Revision revision, Revision pegRevision, boolean force, boolean ignoreExternals, int depth, String nativeEOL) throws ClientExceptionExports the contents of either a subversion repository into a 'clean' directory (meaning a directory with no administrative directories).- Parameters:
srcPath
- the url of the repository path to be exporteddestPath
- a destination path that must not already exist.revision
- the revsion to be exportedpegRevision
- the revision to interpret srcPathforce
- set if it is ok to overwrite local filesignoreExternals
- ignore external during exportdepth
- how deep to recurse in subdirectoriesnativeEOL
- which EOL characters to use during export- Throws:
ClientException
- Since:
- 1.5
-
doSwitch
Deprecated.UsedoSwitch(String, String, Revision, boolean)
instead.Update local copy to mirror a new url.- Parameters:
path
- the working copy pathurl
- the new url for the working copyrevision
- the new base revision of working copyrecurse
- traverse into subdirectories- Throws:
ClientException
- Since:
- 1.0
-
doSwitch
long doSwitch(String path, String url, Revision revision, Revision pegRevision, int depth, boolean depthIsSticky, boolean ignoreExternals, boolean allowUnverObstructions) throws ClientExceptionUpdate local copy to mirror a new url.- Parameters:
path
- the working copy pathurl
- the new url for the working copyrevision
- the new base revision of working copypegRevision
- the revision at which to interpretpath
depth
- how deep to traverse into subdirectoriesdepthIsSticky
- if set, and depth is notDepth.unknown
, then also set the ambient depth value to depth.ignoreExternals
- whether to process externals definitionsallowUnverObstructions
- allow unversioned paths that obstruct adds- Throws:
ClientException
- Since:
- 1.5
-
doImport
Deprecated.Use#doImport(String, String, String, int, boolean, boolean)
instead.Import a file or directory into a repository directory at head.- Parameters:
path
- the local pathurl
- the target urlmessage
- the log message.recurse
- traverse into subdirectories- Throws:
ClientException
- Since:
- 1.0
-
doImport
void doImport(String path, String url, String message, int depth, boolean noIgnore, boolean ignoreUnknownNodeTypes, Map revpropTable) throws ClientExceptionImport a file or directory into a repository directory at head.- Parameters:
path
- the local pathurl
- the target urlmessage
- the log message.depth
- depth to traverse into subdirectoriesnoIgnore
- whether to add files matched by ignore patternsignoreUnknownNodeTypes
- whether to ignore files which the node type is not konwn, just as pipesrevpropTable
- A string-to-string mapping of revision properties to values which will be set if this operation results in a commit.- Throws:
ClientException
- Since:
- 1.5
-
suggestMergeSources
Return an ordered list of suggested merge source URLs.- Parameters:
path
- The merge target path for which to suggest sources.pegRevision
- Peg revision used to interpret path.- Returns:
- The list of URLs, empty if there are no suggestions.
- Throws:
ClientException
- If an error occurs.SubversionException
- Since:
- 1.5
-
merge
void merge(String path1, Revision revision1, String path2, Revision revision2, String localPath, boolean force, boolean recurse) throws ClientExceptionDeprecated.Merge changes from two paths into a new local path.- Parameters:
path1
- first path or urlrevision1
- first revisionpath2
- second path or urlrevision2
- second revisionlocalPath
- target local pathforce
- overwrite local changesrecurse
- traverse into subdirectories- Throws:
ClientException
- Since:
- 1.0
-
merge
void merge(String path1, Revision revision1, String path2, Revision revision2, String localPath, boolean force, boolean recurse, boolean ignoreAncestry, boolean dryRun) throws ClientExceptionDeprecated.Merge changes from two paths into a new local path.- Parameters:
path1
- first path or urlrevision1
- first revisionpath2
- second path or urlrevision2
- second revisionlocalPath
- target local pathforce
- overwrite local changesrecurse
- traverse into subdirectoriesignoreAncestry
- ignore if files are not relateddryRun
- do not change anything- Throws:
ClientException
- Since:
- 1.2
-
merge
void merge(String path1, Revision revision1, String path2, Revision revision2, String localPath, boolean force, int depth, boolean ignoreAncestry, boolean dryRun, boolean recordOnly) throws ClientExceptionMerge changes from two paths into a new local path.- Parameters:
path1
- first path or urlrevision1
- first revisionpath2
- second path or urlrevision2
- second revisionlocalPath
- target local pathforce
- overwrite local changesdepth
- how deep to traverse into subdirectoriesignoreAncestry
- ignore if files are not relateddryRun
- do not change anythingrecordOnly
- record mergeinfo but do not run merge- Throws:
ClientException
- Since:
- 1.5
-
merge
void merge(String path, Revision pegRevision, Revision revision1, Revision revision2, String localPath, boolean force, boolean recurse, boolean ignoreAncestry, boolean dryRun) throws ClientExceptionDeprecated.Merge changes from two paths into a new local path.- Parameters:
path
- path or urlpegRevision
- revision to interpret pathrevision1
- first revisionrevision2
- second revisionlocalPath
- target local pathforce
- overwrite local changesrecurse
- traverse into subdirectoriesignoreAncestry
- ignore if files are not relateddryRun
- do not change anything- Throws:
ClientException
- Since:
- 1.2
-
merge
void merge(String path, Revision pegRevision, RevisionRange[] revisions, String localPath, boolean force, int depth, boolean ignoreAncestry, boolean dryRun, boolean recordOnly) throws ClientExceptionMerge set of revisions into a new local path.- Parameters:
path
- path or urlpegRevision
- revision to interpret pathrevisions
- revisions to mergelocalPath
- target local pathforce
- overwrite local changesdepth
- how deep to traverse into subdirectoriesignoreAncestry
- ignore if files are not relateddryRun
- do not change anythingrecordOnly
- record mergeinfo but do not run merge- Throws:
ClientException
- Since:
- 1.5
-
mergeReintegrate
void mergeReintegrate(String path, Revision pegRevision, String localPath, boolean dryRun) throws ClientExceptionPerform a reintegration merge of path into localPath. localPath must be a single-revision, infinite depth, pristine, unswitched working copy -- in other words, it must reflect a single revision tree, the "target". The mergeinfo on path must reflect that all of the target has been merged into it. Then this behaves like a merge from the target's URL to the localPath. The depth of the merge is always infinity.- Parameters:
path
- path or urlpegRevision
- revision to interpret pathlocalPath
- target local pathdryRun
- do not change anything- Throws:
ClientException
- Since:
- 1.5
-
getMergeinfo
Get mergeinfo forpath
atpegRevision
.- Parameters:
path
- WC path or URL.pegRevision
- peg revision at which to get the merge info forpath
.- Returns:
- The merge history of
path
. - Throws:
SubversionException
- Since:
- 1.5
-
getMergeinfoLog
void getMergeinfoLog(int kind, String pathOrUrl, Revision pegRevision, String mergeSourceUrl, Revision srcPegRevision, boolean discoverChangedPaths, int depth, String[] revProps, LogMessageCallback callback) throws ClientExceptionRetrieve either merged or eligible-to-be-merged revisions.- Parameters:
kind
- kind of revisions to receive: See {@see org.apache.subversion.javahl.MergeinfoLogKind}.pathOrUrl
- target of mergepegRevision
- peg rev for pathOrUrlmergeSourceUrl
- the source of the mergesrcPegRevision
- peg rev for mergeSourceUrldiscoverChangedPaths
- return paths of changed itemsdepth
- the depth to recurse torevProps
- the revprops to retrievecallback
- the object to receive the log messages- Throws:
ClientException
- Since:
- 1.7
-
getMergeinfoLog
void getMergeinfoLog(int kind, String pathOrUrl, Revision pegRevision, String mergeSourceUrl, Revision srcPegRevision, boolean discoverChangedPaths, String[] revProps, LogMessageCallback callback) throws ClientExceptionDeprecated.Retrieve either merged or eligible-to-be-merged revisions.- Parameters:
kind
- kind of revisions to receive: See {@see org.apache.subversion.javahl.MergeinfoLogKind}.pathOrUrl
- target of mergepegRevision
- peg rev for pathOrUrlmergeSourceUrl
- the source of the mergesrcPegRevision
- peg rev for mergeSourceUrldiscoverChangedPaths
- return paths of changed itemsrevProps
- the revprops to retrievecallback
- the object to receive the log messages- Throws:
ClientException
- Since:
- 1.5
-
diff
void diff(String target1, Revision revision1, String target2, Revision revision2, String outFileName, boolean recurse) throws ClientExceptionDeprecated.Use#diff(String, Revision, String, Revision, String, String, int, boolean, boolean, boolean)
instead.Display the differences between two paths- Parameters:
target1
- first path or urlrevision1
- first revisiontarget2
- second path or urlrevision2
- second revisionoutFileName
- file name where difference are writtenrecurse
- traverse into subdirectories- Throws:
ClientException
- Since:
- 1.0
-
diff
void diff(String target1, Revision revision1, String target2, Revision revision2, String outFileName, boolean recurse, boolean ignoreAncestry, boolean noDiffDeleted, boolean force) throws ClientExceptionDeprecated.Use#diff(String, Revision, String, Revision, String, String, int, boolean, boolean, boolean)
instead.Display the differences between two paths- Parameters:
target1
- first path or urlrevision1
- first revisiontarget2
- second path or urlrevision2
- second revisionoutFileName
- file name where difference are writtenrecurse
- traverse into subdirectoriesignoreAncestry
- ignore if files are not relatednoDiffDeleted
- no output on deleted filesforce
- diff even on binary files- Throws:
ClientException
- Since:
- 1.2
-
diff
void diff(String target1, Revision revision1, String target2, Revision revision2, String relativeToDir, String outFileName, int depth, String[] changelists, boolean ignoreAncestry, boolean noDiffDeleted, boolean force, boolean copiesAsAdds) throws ClientExceptionDisplay the differences between two paths- Parameters:
target1
- first path or urlrevision1
- first revisiontarget2
- second path or urlrevision2
- second revisionrelativeToDir
- index path is relative to this pathoutFileName
- file name where difference are writtendepth
- how deep to traverse into subdirectoriesignoreAncestry
- ignore if files are not relatednoDiffDeleted
- no output on deleted filesforce
- diff even on binary filescopiesAsAdds
- if set, copied files will be shown in their entirety, not as diffs from their sources- Throws:
ClientException
- Since:
- 1.7
-
diff
void diff(String target1, Revision revision1, String target2, Revision revision2, String relativeToDir, String outFileName, int depth, String[] changelists, boolean ignoreAncestry, boolean noDiffDeleted, boolean force) throws ClientExceptionDeprecated.Use#diff(String, Revision, String, Revision, String, String, int, boolean, boolean, boolean, boolean)
instead.Display the differences between two paths- Parameters:
target1
- first path or urlrevision1
- first revisiontarget2
- second path or urlrevision2
- second revisionrelativeToDir
- index path is relative to this pathoutFileName
- file name where difference are writtendepth
- how deep to traverse into subdirectoriesignoreAncestry
- ignore if files are not relatednoDiffDeleted
- no output on deleted filesforce
- diff even on binary files- Throws:
ClientException
- Since:
- 1.5
-
diff
void diff(String target, Revision pegRevision, Revision startRevision, Revision endRevision, String outFileName, boolean recurse, boolean ignoreAncestry, boolean noDiffDeleted, boolean force) throws ClientExceptionDeprecated.Use#diff(String, Revision, Revision, Revision, String, String, int, boolean, boolean, boolean)
instead.Display the differences between two paths.- Parameters:
target
- path or urlpegRevision
- revision tointerpret targetstartRevision
- first Revision to compareendRevision
- second Revision to compareoutFileName
- file name where difference are writtenrecurse
- traverse into subdirectoriesignoreAncestry
- ignore if files are not relatednoDiffDeleted
- no output on deleted filesforce
- diff even on binary files- Throws:
ClientException
- Since:
- 1.2
-
diff
void diff(String target, Revision pegRevision, Revision startRevision, Revision endRevision, String relativeToDir, String outFileName, int depth, String[] changelists, boolean ignoreAncestry, boolean noDiffDeleted, boolean force, boolean copiesAsAdds) throws ClientExceptionDisplay the differences between two paths.- Parameters:
target
- path or urlpegRevision
- revision tointerpret targetstartRevision
- first Revision to compareendRevision
- second Revision to comparerelativeToDir
- index path is relative to this pathoutFileName
- file name where difference are writtendepth
- how deep to traverse into subdirectorieschangelists
- if non-null, filter paths using changelistsignoreAncestry
- ignore if files are not relatednoDiffDeleted
- no output on deleted filesforce
- diff even on binary filescopiesAsAdds
- if set, copied files will be shown in their entirety, not as diffs from their sources- Throws:
ClientException
- Since:
- 1.7
-
diff
void diff(String target, Revision pegRevision, Revision startRevision, Revision endRevision, String relativeToDir, String outFileName, int depth, String[] changelists, boolean ignoreAncestry, boolean noDiffDeleted, boolean force) throws ClientExceptionDeprecated.Use#diff(String, Revision, Revision, Revision, String, String, int, boolean, boolean, boolean, boolean)
instead.Display the differences between two paths.- Parameters:
target
- path or urlpegRevision
- revision tointerpret targetstartRevision
- first Revision to compareendRevision
- second Revision to comparerelativeToDir
- index path is relative to this pathoutFileName
- file name where difference are writtendepth
- how deep to traverse into subdirectorieschangelists
- if non-null, filter paths using changelistsignoreAncestry
- ignore if files are not relatednoDiffDeleted
- no output on deleted filesforce
- diff even on binary files- Throws:
ClientException
- Since:
- 1.5
-
diffSummarize
void diffSummarize(String target1, Revision revision1, String target2, Revision revision2, int depth, String[] changelists, boolean ignoreAncestry, DiffSummaryReceiver receiver) throws ClientExceptionProduce a diff summary which lists the items changed between path and revision pairs.- Parameters:
target1
- Path or URL.revision1
- Revision oftarget1
.target2
- Path or URL.revision2
- Revision oftarget2
.depth
- how deep to recurse.changelists
- if non-null, filter paths using changelistsignoreAncestry
- Whether to ignore unrelated files during comparison. False positives may potentially be reported if this parameterfalse
, since a file might have been modified between two revisions, but still have the same contents.receiver
- As each is difference is found, this callback is invoked with a description of the difference.- Throws:
ClientException
- Since:
- 1.5
-
diffSummarize
void diffSummarize(String target, Revision pegRevision, Revision startRevision, Revision endRevision, int depth, String[] changelists, boolean ignoreAncestry, DiffSummaryReceiver receiver) throws ClientExceptionProduce a diff summary which lists the items changed between path and revision pairs.- Parameters:
target
- Path or URL.pegRevision
- Revision at which to interprettarget
. IfRevisionKind.unspecified
ornull
, behave identically to#diffSummarize(String, Revision, String, Revision, int, boolean, DiffSummaryReceiver)
, usingpath
for both of that method's targets.startRevision
- Beginning of range for comparison oftarget
.endRevision
- End of range for comparison oftarget
.depth
- how deep to recurse.changelists
- if non-null, filter paths using changelistsignoreAncestry
- Whether to ignore unrelated files during comparison. False positives may potentially be reported if this parameterfalse
, since a file might have been modified between two revisions, but still have the same contents.receiver
- As each is difference is found, this callback is invoked with a description of the difference.- Throws:
ClientException
- Since:
- 1.5
-
properties
Deprecated.Use#properties(String, Revision, Revision, int, ProplistCallback)
instead.Retrieves the properties of an item- Parameters:
path
- the path of the item- Returns:
- array of property objects
- Throws:
ClientException
- Since:
- 1.0
-
properties
Deprecated.Use#properties(String, Revision, Revision, int, ProplistCallback)
instead.Retrieves the properties of an item- Parameters:
path
- the path of the itemrevision
- the revision of the item- Returns:
- array of property objects
- Throws:
ClientException
- Since:
- 1.2
-
properties
PropertyData[] properties(String path, Revision revision, Revision pegRevision) throws ClientExceptionDeprecated.Use#properties(String, Revision, Revision, int, ProplistCallback)
instead.Retrieves the properties of an item- Parameters:
path
- the path of the itemrevision
- the revision of the itempegRevision
- the revision to interpret path- Returns:
- array of property objects
- Throws:
ClientException
- Since:
- 1.2
-
properties
void properties(String path, Revision revision, Revision pegRevision, int depth, String[] changelists, ProplistCallback callback) throws ClientExceptionRetrieves the properties of an item- Parameters:
path
- the path of the itemrevision
- the revision of the itempegRevision
- the revision to interpret pathdepth
- the depth to recurse into subdirectorieschangelists
- changelists to filter bycallback
- the callback to use to return the properties- Throws:
ClientException
- Since:
- 1.5
-
propertySet
Deprecated.Use#propertySet(String, String, String, int, boolean)
instead.Sets one property of an item with a String value- Parameters:
path
- path of the itemname
- name of the propertyvalue
- new value of the propertyrecurse
- set property also on the subdirectories- Throws:
ClientException
- Since:
- 1.0
-
propertySet
void propertySet(String path, String name, String value, boolean recurse, boolean force) throws ClientExceptionDeprecated.Use#propertySet(String, String, String, int, boolean)
instead.Sets one property of an item with a String value- Parameters:
path
- path of the itemname
- name of the propertyvalue
- new value of the propertyrecurse
- set property also on the subdirectoriesforce
- do not check if the value is valid- Throws:
ClientException
- Since:
- 1.2
-
propertySet
Deprecated.Use#propertySet(String, String, String, int, boolean)
instead.Sets one property of an item with a byte array value- Parameters:
path
- path of the itemname
- name of the propertyvalue
- new value of the propertyrecurse
- set property also on the subdirectories- Throws:
ClientException
- Since:
- 1.0
-
propertySet
void propertySet(String path, String name, byte[] value, boolean recurse, boolean force) throws ClientExceptionDeprecated.Use#propertySet(String, String, String, int, boolean)
instead.Sets one property of an item with a byte array value- Parameters:
path
- path of the itemname
- name of the propertyvalue
- new value of the propertyrecurse
- set property also on the subdirectoriesforce
- do not check if the value is valid- Throws:
ClientException
- Since:
- 1.2
-
propertySet
void propertySet(String path, String name, String value, int depth, String[] changelists, boolean force, Map revpropTable) throws ClientExceptionSets one property of an item with a String value- Parameters:
path
- path of the itemname
- name of the propertyvalue
- new value of the propertydepth
- the depth to recurse into subdirectorieschangelists
- changelists to filter byforce
- do not check if the value is validrevpropTable
- A string-to-string mapping of revision properties to values which will be set if this operation results in a commit.- Throws:
ClientException
- Since:
- 1.5
-
propertyRemove
Deprecated.Use#propertyRemove(String, String, int)
instead.Remove one property of an item.- Parameters:
path
- path of the itemname
- name of the propertyrecurse
- remove the property also on subdirectories- Throws:
ClientException
- Since:
- 1.0
-
propertyRemove
void propertyRemove(String path, String name, int depth, String[] changelists) throws ClientExceptionRemove one property of an item.- Parameters:
path
- path of the itemname
- name of the propertydepth
- the depth to recurse into subdirectorieschangelists
- changelists to filter by- Throws:
ClientException
- Since:
- 1.5
-
propertyCreate
void propertyCreate(String path, String name, String value, boolean recurse) throws ClientExceptionDeprecated.Use#propertyCreate(String, String, String, int, boolean)
instead.Create and sets one property of an item with a String value- Parameters:
path
- path of the itemname
- name of the propertyvalue
- new value of the propertyrecurse
- set property also on the subdirectories- Throws:
ClientException
- Since:
- 1.0
-
propertyCreate
void propertyCreate(String path, String name, String value, boolean recurse, boolean force) throws ClientExceptionDeprecated.Use#propertyCreate(String, String, String, int, boolean)
instead.Create and sets one property of an item with a String value- Parameters:
path
- path of the itemname
- name of the propertyvalue
- new value of the propertyrecurse
- set property also on the subdirectoriesforce
- do not check if the value is valid- Throws:
ClientException
- Since:
- 1.2
-
propertyCreate
void propertyCreate(String path, String name, byte[] value, boolean recurse) throws ClientExceptionDeprecated.Use#propertyCreate(String, String, String, int, boolean)
instead.Create and sets one property of an item with a byte array value- Parameters:
path
- path of the itemname
- name of the propertyvalue
- new value of the propertyrecurse
- set property also on the subdirectories- Throws:
ClientException
- Since:
- 1.0
-
propertyCreate
void propertyCreate(String path, String name, byte[] value, boolean recurse, boolean force) throws ClientExceptionDeprecated.Use#propertyCreate(String, String, String, int, boolean)
instead.Create and sets one property of an item with a byte array value- Parameters:
path
- path of the itemname
- name of the propertyvalue
- new value of the propertyrecurse
- set property also on the subdirectoriesforce
- do not check if the value is valid- Throws:
ClientException
- Since:
- 1.2
-
propertyCreate
void propertyCreate(String path, String name, String value, int depth, String[] changelists, boolean force) throws ClientExceptionCreate and sets one property of an item with a byte array value- Parameters:
path
- path of the itemname
- name of the propertyvalue
- new value of the propertydepth
- depth to set property on the subdirectorieschangelists
- changelists to filter byforce
- do not check if the value is valid- Throws:
ClientException
- Since:
- 1.5
-
revProperty
Retrieve one revsision property of one item- Parameters:
path
- path of the itemname
- name of the propertyrev
- revision to retrieve- Returns:
- the Property
- Throws:
ClientException
- Since:
- 1.0
-
revProperties
Retrieve all revsision properties of one item- Parameters:
path
- path of the itemrev
- revision to retrieve- Returns:
- the Properties
- Throws:
ClientException
- Since:
- 1.2
-
setRevProperty
void setRevProperty(String path, String name, Revision rev, String value, boolean force) throws ClientExceptionset one revsision property of one item- Parameters:
path
- path of the itemname
- name of the propertyrev
- revision to retrievevalue
- value of the propertyforce
- use force to set- Throws:
ClientException
- Since:
- 1.2
-
setRevProperty
void setRevProperty(String path, String name, Revision rev, String value, String originalValue, boolean force) throws ClientExceptionset one revsision property of one item- Parameters:
path
- path of the itemname
- name of the propertyrev
- revision to retrievevalue
- value of the propertyoriginalValue
- the original value of the property.force
- use force to set- Throws:
ClientException
- Since:
- 1.6
-
propertyGet
Deprecated.UsepropertyGet(String, String, Revision)
instead.Retrieve one property of one item- Parameters:
path
- path of the itemname
- name of property- Returns:
- the Property
- Throws:
ClientException
- Since:
- 1.0
-
propertyGet
Retrieve one property of one item- Parameters:
path
- path of the itemname
- name of propertyrevision
- revision of the item- Returns:
- the Property
- Throws:
ClientException
- Since:
- 1.2
-
propertyGet
PropertyData propertyGet(String path, String name, Revision revision, Revision pegRevision) throws ClientExceptionRetrieve one property of one item- Parameters:
path
- path of the itemname
- name of propertyrevision
- revision of the itempegRevision
- the revision to interpret path- Returns:
- the Property
- Throws:
ClientException
- Since:
- 1.2
-
fileContent
Deprecated.UsefileContent(String, Revision, Revision)
instead.Retrieve the content of a file- Parameters:
path
- the path of the filerevision
- the revision to retrieve- Returns:
- the content as byte array
- Throws:
ClientException
- Since:
- 1.0
-
fileContent
Retrieve the content of a file- Parameters:
path
- the path of the filerevision
- the revision to retrievepegRevision
- the revision to interpret path- Returns:
- the content as byte array
- Throws:
ClientException
- Since:
- 1.2
-
streamFileContent
void streamFileContent(String path, Revision revision, Revision pegRevision, int bufferSize, OutputStream stream) throws ClientExceptionWrite the file's content to the specified output stream. If you need an InputStream, use a PipedInputStream/PipedOutputStream combination.- Parameters:
path
- the path of the filerevision
- the revision to retrievepegRevision
- the revision at which to interpret the pathstream
- the stream to write the file's content to- Throws:
ClientException
- Since:
- 1.0
- See Also:
PipedOutputStream
,PipedInputStream
-
relocate
Rewrite the url's in the working copy- Parameters:
from
- old urlto
- new urlpath
- working copy pathrecurse
- recurse into subdirectories- Throws:
ClientException
- Since:
- 1.0
-
blame
Deprecated.Return for each line of the file, the author and the revision of the last together with the content.- Parameters:
path
- the pathrevisionStart
- the first revision to showrevisionEnd
- the last revision to show- Returns:
- the content together with author and revision of last change
- Throws:
ClientException
- Since:
- 1.0
-
blame
void blame(String path, Revision revisionStart, Revision revisionEnd, BlameCallback callback) throws ClientExceptionDeprecated.Retrieve the content together with the author, the revision and the date of the last change of each line- Parameters:
path
- the pathrevisionStart
- the first revision to showrevisionEnd
- the last revision to showcallback
- callback to receive the file content and the other information- Throws:
ClientException
- Since:
- 1.0
-
blame
void blame(String path, Revision pegRevision, Revision revisionStart, Revision revisionEnd, BlameCallback callback) throws ClientExceptionDeprecated.Retrieve the content together with the author, the revision and the date of the last change of each line- Parameters:
path
- the pathpegRevision
- the revision to interpret the pathrevisionStart
- the first revision to showrevisionEnd
- the last revision to showcallback
- callback to receive the file content and the other information- Throws:
ClientException
- Since:
- 1.2
-
blame
void blame(String path, Revision pegRevision, Revision revisionStart, Revision revisionEnd, boolean ignoreMimeType, boolean includeMergedRevisions, BlameCallback2 callback) throws ClientExceptionDeprecated.Retrieve the content together with the author, the revision and the date of the last change of each line- Parameters:
path
- the pathpegRevision
- the revision to interpret the pathrevisionStart
- the first revision to showrevisionEnd
- the last revision to showignoreMimeType
- whether or not to ignore the mime-typeincludeMergedRevisions
- whether or not to include extra merge informationcallback
- callback to receive the file content and the other information- Throws:
ClientException
- Since:
- 1.5
-
blame
void blame(String path, Revision pegRevision, Revision revisionStart, Revision revisionEnd, boolean ignoreMimeType, boolean includeMergedRevisions, BlameCallback3 callback) throws ClientExceptionRetrieve the content together with the author, the revision and the date of the last change of each line- Parameters:
path
- the pathpegRevision
- the revision to interpret the pathrevisionStart
- the first revision to showrevisionEnd
- the last revision to showignoreMimeType
- whether or not to ignore the mime-typeincludeMergedRevisions
- whether or not to include extra merge informationcallback
- callback to receive the file content and the other information- Throws:
ClientException
- Since:
- 1.7
-
setConfigDirectory
Set directory for the configuration information, taking the usual steps to ensure that Subversion's config file templates exist in the specified location.. On Windows, setting a non-null
value will override lookup of configuration in the registry.- Parameters:
configDir
- Path of the directory, ornull
for the platform's default.- Throws:
ClientException
- Since:
- 1.0
-
getConfigDirectory
Get the configuration directory- Returns:
- the directory
- Throws:
ClientException
- Since:
- 1.0
-
cancelOperation
cancel the active operation- Throws:
ClientException
- Since:
- 1.0
-
info
Deprecated.Use#info2(String, Revision, Revision, int, InfoCallback)
instead.Retrieves the working copy information for an item- Parameters:
path
- path of the item- Returns:
- the information object
- Throws:
ClientException
- Since:
- 1.0
-
addToChangelist
void addToChangelist(String[] paths, String changelist, int depth, String[] changelists) throws ClientExceptionAdd paths to a changelist- Parameters:
paths
- paths to add to the changelistchangelist
- changelist namedepth
- the depth to recursechangelists
- changelists to filter by- Throws:
ClientException
- Since:
- 1.5
-
removeFromChangelists
Remove paths from a changelist- Parameters:
paths
- paths to remove from the changelistdepth
- the depth to recursechangelists
- changelists to filter by- Throws:
ClientException
- Since:
- 1.5
-
getChangelists
void getChangelists(String rootPath, String[] changelists, int depth, ChangelistCallback callback) throws ClientExceptionRecursively get the paths which belong to a changelist- Parameters:
rootPath
- the wc path under which to checkchangelists
- the changelists to look underdepth
- the depth to recursecallback
- the callback to return the changelists through- Throws:
ClientException
- Since:
- 1.5
-
lock
Lock a working copy item- Parameters:
path
- path of the itemcomment
-force
- break an existing lock- Throws:
ClientException
- Since:
- 1.2
-
unlock
Unlock a working copy item- Parameters:
path
- path of the itemforce
- break an existing lock- Throws:
ClientException
- Since:
- 1.2
-
info2
Info2[] info2(String pathOrUrl, Revision revision, Revision pegRevision, boolean recurse) throws ClientExceptionDeprecated.Use#info2(String, Revision, Revision, int, InfoCallback)
instead.Retrieve information about repository or working copy items.- Parameters:
pathOrUrl
- the path or the url of the itemrevision
- the revision of the item to returnpegRevision
- the revision to interpret pathOrUrlrecurse
- flag if to recurse, if the item is a directory- Returns:
- the information objects
- Throws:
ClientException
- Since:
- 1.2
-
info2
void info2(String pathOrUrl, Revision revision, Revision pegRevision, int depth, String[] changelists, InfoCallback callback) throws ClientExceptionRetrieve information about repository or working copy items.- Parameters:
pathOrUrl
- the path or the url of the itemrevision
- the revision of the item to returnpegRevision
- the revision to interpret pathOrUrldepth
- the depth to recursechangelists
- if non-null, filter paths using changelistscallback
- a callback to receive the infos retrieved- Throws:
ClientException
- Since:
- 1.5
-
getVersionInfo
Produce a compact "version number" for a working copy- Parameters:
path
- path of the working copytrailUrl
- to detect switches of the whole working copylastChanged
- last changed rather than current revisions- Returns:
- the compact "version number"
- Throws:
ClientException
- Since:
- 1.2
-
upgrade
Recursively upgrade a working copy to a new metadata storage format.- Parameters:
path
- path of the working copy- Throws:
ClientException
- Since:
- 1.7
-