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
 void add(java.lang.String path, boolean recurse)
          Adds a file to the repository.
 void add(java.lang.String path, boolean recurse, boolean force)
          Adds a file to the repository.
 byte[] blame(java.lang.String path, Revision revisionStart, Revision revisionEnd)
          Deprecated.  
 void blame(java.lang.String path, Revision revisionStart, Revision revisionEnd, BlameCallback callback)
          Retrieve the content together with the author, the revision and the date of the last change of each line
 void blame(java.lang.String path, Revision pegRevision, Revision revisionStart, Revision revisionEnd, BlameCallback callback)
          Retrieve the content together with the author, the revision and the date of the last change of each line
 void cancelOperation()
          cancel the active operation
 long checkout(java.lang.String moduleName, java.lang.String destPath, Revision revision, boolean recurse)
          Executes a revision checkout.
 long checkout(java.lang.String moduleName, java.lang.String destPath, Revision revision, Revision pegRevision, boolean recurse, boolean ignoreExternals)
          Executes a revision checkout.
 void cleanup(java.lang.String path)
          Recursively cleans up a local directory, finishing any incomplete operations, removing lockfiles, etc.
 long commit(java.lang.String[] path, java.lang.String message, boolean recurse)
          Commits changes to the repository.
 long commit(java.lang.String[] path, java.lang.String message, boolean recurse, boolean noUnlock)
          Commits changes to the repository.
 void commitMessageHandler(CommitMessage messageHandler)
          Sets the commit message handler.
 void copy(java.lang.String srcPath, java.lang.String destPath, java.lang.String message, Revision revision)
          Copies a versioned file with the history preserved.
 void diff(java.lang.String target, Revision pegRevision, Revision startRevision, Revision endRevision, java.lang.String outFileName, boolean recurse, boolean ignoreAncestry, boolean noDiffDeleted, boolean force)
          Display the differences between two paths
 void diff(java.lang.String target1, Revision revision1, java.lang.String target2, Revision revision2, java.lang.String outFileName, boolean recurse)
          Display the differences between two paths
 void diff(java.lang.String target1, Revision revision1, java.lang.String target2, Revision revision2, java.lang.String outFileName, boolean recurse, boolean ignoreAncestry, boolean noDiffDeleted, boolean force)
          Display the differences between two paths
 void dispose()
          release the native peer (should not depend on finalize)
 long doExport(java.lang.String srcPath, java.lang.String destPath, Revision revision, boolean force)
          Exports the contents of either a subversion repository into a 'clean' directory (meaning a directory with no administrative directories).
 long doExport(java.lang.String srcPath, java.lang.String destPath, Revision revision, Revision pegRevision, boolean force, boolean ignoreExternals, boolean recurse, java.lang.String nativeEOL)
          Exports the contents of either a subversion repository into a 'clean' directory (meaning a directory with no administrative directories).
 void doImport(java.lang.String path, java.lang.String url, java.lang.String message, boolean recurse)
          Import a file or directory into a repository directory at head.
 long doSwitch(java.lang.String path, java.lang.String url, Revision revision, boolean recurse)
          Update local copy to mirror a new url.
 byte[] fileContent(java.lang.String path, Revision revision)
          Retrieve the content of a file
 byte[] fileContent(java.lang.String path, Revision revision, Revision pegRevision)
          Retrieve the content of a file
 java.lang.String getAdminDirectoryName()
           
 java.lang.String getConfigDirectory()
          Get the configuration directory
 java.lang.String getLastPath()
          Deprecated.  
 Version getVersion()
           
 java.lang.String getVersionInfo(java.lang.String path, java.lang.String trailUrl, boolean lastChanged)
          Produce a compact "version number" for a working copy
 Info info(java.lang.String path)
          Retrieves the working copy information for an item
 Info2[] info2(java.lang.String pathOrUrl, Revision revision, Revision pegRevision, boolean recurse)
          Retrieve information about repository or working copy items.
 boolean isAdminDirectory(java.lang.String name)
           
 DirEntry[] list(java.lang.String url, Revision revision, boolean recurse)
          Lists the directory entries of an url on the server.
 DirEntry[] list(java.lang.String url, Revision revision, Revision pegRevision, boolean recurse)
          Lists the directory entries of an url on the server.
 void lock(java.lang.String[] path, java.lang.String comment, boolean force)
          Lock a working copy item
 LogMessage[] logMessages(java.lang.String path, Revision revisionStart, Revision revisionEnd)
          Retrieve the log messages for an item
 LogMessage[] logMessages(java.lang.String path, Revision revisionStart, Revision revisionEnd, boolean stopOnCopy)
          Retrieve the log messages for an item
 LogMessage[] logMessages(java.lang.String path, Revision revisionStart, Revision revisionEnd, boolean stopOnCopy, boolean discoverPath)
          Retrieve the log messages for an item
 LogMessage[] logMessages(java.lang.String path, Revision revisionStart, Revision revisionEnd, boolean stopOnCopy, boolean discoverPath, long limit)
          Retrieve the log messages for an item
 void merge(java.lang.String path, Revision pegRevision, Revision revision1, Revision revision2, java.lang.String localPath, boolean force, boolean recurse, boolean ignoreAncestry, boolean dryRun)
          Merge changes from two paths into a new local path.
 void merge(java.lang.String path1, Revision revision1, java.lang.String path2, Revision revision2, java.lang.String localPath, boolean force, boolean recurse)
          Merge changes from two paths into a new local path.
 void merge(java.lang.String path1, Revision revision1, java.lang.String path2, Revision revision2, java.lang.String localPath, boolean force, boolean recurse, boolean ignoreAncestry, boolean dryRun)
          Merge changes from two paths into a new local path.
 void mkdir(java.lang.String[] path, java.lang.String message)
          Creates a directory directly in a repository or creates a directory on disk and schedules it for addition.
 void move(java.lang.String srcPath, java.lang.String destPath, java.lang.String message, boolean force)
          Moves or renames a file.
 void move(java.lang.String srcPath, java.lang.String destPath, java.lang.String message, Revision revision, boolean force)
          Moves or renames a file.
 void notification(Notify notify)
          Deprecated. use notification2 instead
 void notification2(Notify2 notify)
          Sets the notification callback used to send processing information back to the calling program.
 void password(java.lang.String password)
          Sets the password used for authentication.
 PropertyData[] properties(java.lang.String path)
          Retrieves the properties of an item
 PropertyData[] properties(java.lang.String path, Revision revision)
          Retrieves the properties of an item
 PropertyData[] properties(java.lang.String path, Revision revision, Revision pegRevision)
          Retrieves the properties of an item
 void propertyCreate(java.lang.String path, java.lang.String name, byte[] value, boolean recurse)
          Create and sets one property of an item with a byte array value
 void propertyCreate(java.lang.String path, java.lang.String name, byte[] value, boolean recurse, boolean force)
          Create and sets one property of an item with a byte array value
 void propertyCreate(java.lang.String path, java.lang.String name, java.lang.String value, boolean recurse)
          Create and sets one property of an item with a String value
 void propertyCreate(java.lang.String path, java.lang.String name, java.lang.String value, boolean recurse, boolean force)
          Create and sets one property of an item with a String value
 PropertyData propertyGet(java.lang.String path, java.lang.String name)
          Retrieve one property of one iten
 PropertyData propertyGet(java.lang.String path, java.lang.String name, Revision revision)
          Retrieve one property of one iten
 PropertyData propertyGet(java.lang.String path, java.lang.String name, Revision revision, Revision pegRevision)
          Retrieve one property of one iten
 void propertyRemove(java.lang.String path, java.lang.String name, boolean recurse)
          Remove one property of an item.
 void propertySet(java.lang.String path, java.lang.String name, byte[] value, boolean recurse)
          Sets one property of an item with a byte array value
 void propertySet(java.lang.String path, java.lang.String name, byte[] value, boolean recurse, boolean force)
          Sets one property of an item with a byte array value
 void propertySet(java.lang.String path, java.lang.String name, java.lang.String value, boolean recurse)
          Sets one property of an item with a String value
 void propertySet(java.lang.String path, java.lang.String name, java.lang.String value, boolean recurse, boolean force)
          Sets one property of an item with a String value
 void relocate(java.lang.String from, java.lang.String to, java.lang.String path, boolean recurse)
          Rewrite the url's in the working copy
 void remove(java.lang.String[] path, java.lang.String message, boolean force)
          Sets a file for deletion.
 void resolved(java.lang.String path, boolean recurse)
          Removes the 'conflicted' state on a file.
 void revert(java.lang.String path, boolean recurse)
          Reverts a file to a pristine state.
 PropertyData[] revProperties(java.lang.String path, Revision rev)
          Retrieve all revsision properties of one item
 PropertyData revProperty(java.lang.String path, java.lang.String name, Revision rev)
          Retrieve one revsision property of one item
 void setConfigDirectory(java.lang.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 setPrompt(PromptUserPassword prompt)
          Register callback interface to supply username and password on demand
 void setRevProperty(java.lang.String path, java.lang.String name, Revision rev, java.lang.String value, boolean force)
          set one revsision property of one item
 Status singleStatus(java.lang.String path, boolean onServer)
          Returns the status of a single file in the path.
 Status[] status(java.lang.String path, boolean descend, boolean onServer, boolean getAll)
          List a directory or file of the working copy.
 Status[] status(java.lang.String path, boolean descend, boolean onServer, boolean getAll, boolean noIgnore)
          List a directory or file of the working copy.
 Status[] status(java.lang.String path, boolean descend, boolean onServer, boolean getAll, boolean noIgnore, boolean ignoreExternals)
          List a directory or file of the working copy.
 void streamFileContent(java.lang.String path, Revision revision, Revision pegRevision, int bufferSize, java.io.OutputStream stream)
          Write the file's content to the specified output stream.
 void unlock(java.lang.String[] path, boolean force)
          Unlock a working copy item
 long[] update(java.lang.String[] path, Revision revision, boolean recurse, boolean ignoreExternals)
          Updates the directories or files from repository
 long update(java.lang.String path, Revision revision, boolean recurse)
          Updates the directory or file from repository
 void username(java.lang.String username)
          Sets the username used for authentication.
 

Method Detail

dispose

void dispose()
release the native peer (should not depend on finalize)


getVersion

Version getVersion()
Returns:
Version information about the underlying native libraries.

getAdminDirectoryName

java.lang.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

boolean isAdminDirectory(java.lang.String name)
Parameters:
name - The name of the directory to compare.
Returns:
Whether name is that of a working copy administrative directory.
Since:
1.3

getLastPath

java.lang.String getLastPath()
Deprecated. 

Returns the last destination path submitted.

Returns:
path in Subversion format.

status

Status[] status(java.lang.String path,
                boolean descend,
                boolean onServer,
                boolean getAll)
                throws ClientException
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 uninteristing files (unchanged).
Returns:
Array of Status entries.
Throws:
ClientException

status

Status[] status(java.lang.String path,
                boolean descend,
                boolean onServer,
                boolean getAll,
                boolean noIgnore)
                throws ClientException
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 uninteristing files (unchanged).
noIgnore - get status for normaly ignored files and directories.
Returns:
Array of Status entries.
Throws:
ClientException

status

Status[] status(java.lang.String path,
                boolean descend,
                boolean onServer,
                boolean getAll,
                boolean noIgnore,
                boolean ignoreExternals)
                throws ClientException
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 uninteristing files (unchanged).
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

list

DirEntry[] list(java.lang.String url,
                Revision revision,
                boolean recurse)
                throws ClientException
Lists the directory entries of an url on the server.

Parameters:
url - the url to list
revision - the revision to list
recurse - recurse into subdirectories
Returns:
Array of DirEntry objects.
Throws:
ClientException

list

DirEntry[] list(java.lang.String url,
                Revision revision,
                Revision pegRevision,
                boolean recurse)
                throws ClientException
Lists the directory entries of an url on the server.

Parameters:
url - the url to list
revision - the revision to list
pegRevision - the revision to interpret url
recurse - recurse into subdirectories
Returns:
Array of DirEntry objects.
Throws:
ClientException
Since:
1.2

singleStatus

Status singleStatus(java.lang.String path,
                    boolean onServer)
                    throws ClientException
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.
Throws:
ClientException

username

void username(java.lang.String 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:
java.lang.IllegalArgumentException - If username is null.
See Also:
password(String)

password

void password(java.lang.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:
java.lang.IllegalArgumentException - If password is null.
See Also:
username(String)

setPrompt

void setPrompt(PromptUserPassword prompt)
Register callback interface to supply username and password on demand

Parameters:
prompt - the callback interface

logMessages

LogMessage[] logMessages(java.lang.String path,
                         Revision revisionStart,
                         Revision revisionEnd)
                         throws ClientException
Retrieve the log messages for an item

Parameters:
path - path or url to get the log message for.
revisionStart - first revision to show
revisionEnd - last revision to show
Returns:
array of LogMessages
Throws:
ClientException

logMessages

LogMessage[] logMessages(java.lang.String path,
                         Revision revisionStart,
                         Revision revisionEnd,
                         boolean stopOnCopy)
                         throws ClientException
Retrieve the log messages for an item

Parameters:
path - path or url to get the log message for.
revisionStart - first revision to show
revisionEnd - last revision to show
stopOnCopy - do not continue on copy operations
Returns:
array of LogMessages
Throws:
ClientException

logMessages

LogMessage[] logMessages(java.lang.String path,
                         Revision revisionStart,
                         Revision revisionEnd,
                         boolean stopOnCopy,
                         boolean discoverPath)
                         throws ClientException
Retrieve the log messages for an item

Parameters:
path - path or url to get the log message for.
revisionStart - first revision to show
revisionEnd - last revision to show
stopOnCopy - do not continue on copy operations
discoverPath - returns the paths of the changed items in the returned objects
Returns:
array of LogMessages
Throws:
ClientException

logMessages

LogMessage[] logMessages(java.lang.String path,
                         Revision revisionStart,
                         Revision revisionEnd,
                         boolean stopOnCopy,
                         boolean discoverPath,
                         long limit)
                         throws ClientException
Retrieve the log messages for an item

Parameters:
path - path or url to get the log message for.
revisionStart - first revision to show
revisionEnd - last revision to show
stopOnCopy - do not continue on copy operations
discoverPath - returns the paths of the changed items in the returned objects
limit - limit the number of log messages (if 0 or less no limit)
Returns:
array of LogMessages
Throws:
ClientException
Since:
1.2

checkout

long checkout(java.lang.String moduleName,
              java.lang.String destPath,
              Revision revision,
              Revision pegRevision,
              boolean recurse,
              boolean ignoreExternals)
              throws ClientException
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 path
recurse - whether you want it to checkout files recursively.
ignoreExternals - if externals are ignored during checkout
Throws:
ClientException
Since:
1.2

checkout

long checkout(java.lang.String moduleName,
              java.lang.String destPath,
              Revision revision,
              boolean recurse)
              throws ClientException
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

notification

void notification(Notify notify)
Deprecated. use notification2 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.

notification2

void notification2(Notify2 notify)
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

commitMessageHandler

void commitMessageHandler(CommitMessage messageHandler)
Sets the commit message handler. This allows more complex commit message with the list of the elements to be commited as input.

Parameters:
messageHandler - callback for entering commit messages if this is set the message parameter is ignored.

remove

void remove(java.lang.String[] path,
            java.lang.String message,
            boolean force)
            throws ClientException
Sets a file for deletion.

Parameters:
path - path or url to be deleted
message - if path is a url, this will be the commit message.
force - delete even when there are local modifications.
Throws:
ClientException

revert

void revert(java.lang.String path,
            boolean recurse)
            throws ClientException
Reverts a file to a pristine state.

Parameters:
path - path of the file.
recurse - recurse into subdirectories
Throws:
ClientException

add

void add(java.lang.String path,
         boolean recurse)
         throws ClientException
Adds a file to the repository.

Parameters:
path - path to be added.
recurse - recurse into subdirectories
Throws:
ClientException

add

void add(java.lang.String path,
         boolean recurse,
         boolean force)
         throws ClientException
Adds a file to the repository.

Parameters:
path - path to be added.
recurse - recurse into subdirectories
force - if adding a directory and recurse true and path is a directory, all not already managed files are added.
Throws:
ClientException
Since:
1.2

update

long update(java.lang.String path,
            Revision revision,
            boolean recurse)
            throws ClientException
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

update

long[] update(java.lang.String[] path,
              Revision revision,
              boolean recurse,
              boolean ignoreExternals)
              throws ClientException
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

commit

long commit(java.lang.String[] path,
            java.lang.String message,
            boolean recurse)
            throws ClientException
Commits changes to the repository.

Parameters:
path - files to commit.
message - log message.
recurse - whether the operation should be done recursively.
Returns:
Returns a long representing the revision. It returns a -1 if the revision number is invalid.
Throws:
ClientException

commit

long commit(java.lang.String[] path,
            java.lang.String message,
            boolean recurse,
            boolean noUnlock)
            throws ClientException
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:
Returns a long representing the revision. It returns a -1 if the revision number is invalid.
Throws:
ClientException

copy

void copy(java.lang.String srcPath,
          java.lang.String destPath,
          java.lang.String message,
          Revision revision)
          throws ClientException
Copies a versioned file with the history preserved.

Parameters:
srcPath - source path or url
destPath - destination path or url
message - commit message if destPath is an url
revision - source revision
Throws:
ClientException

move

void move(java.lang.String srcPath,
          java.lang.String destPath,
          java.lang.String message,
          Revision revision,
          boolean force)
          throws ClientException
Moves or renames a file.

Parameters:
srcPath - source path or url
destPath - destination path or url
message - commit message if destPath is an url
revision - source revision (unused)
force - even with local modifications.
Throws:
ClientException

move

void move(java.lang.String srcPath,
          java.lang.String destPath,
          java.lang.String message,
          boolean force)
          throws ClientException
Moves or renames a file.

Parameters:
srcPath - source path or url
destPath - destination path or url
message - commit message if destPath is an url
force - even with local modifications.
Throws:
ClientException
Since:
1.2

mkdir

void mkdir(java.lang.String[] path,
           java.lang.String message)
           throws ClientException
Creates a directory directly in a repository or creates a directory on disk and schedules it for addition.

Parameters:
path - directories to be created
message - commit message to used if path contains urls
Throws:
ClientException

cleanup

void cleanup(java.lang.String path)
             throws ClientException
Recursively cleans up a local directory, finishing any incomplete operations, removing lockfiles, etc.

Parameters:
path - a local directory.
Throws:
ClientException

resolved

void resolved(java.lang.String path,
              boolean recurse)
              throws ClientException
Removes the 'conflicted' state on a file.

Parameters:
path - path to cleanup
recurse - recurce into subdirectories
Throws:
ClientException

doExport

long doExport(java.lang.String srcPath,
              java.lang.String destPath,
              Revision revision,
              boolean force)
              throws ClientException
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 exported
destPath - a destination path that must not already exist.
revision - the revsion to be exported
force - set if it is ok to overwrite local files
Throws:
ClientException

doExport

long doExport(java.lang.String srcPath,
              java.lang.String destPath,
              Revision revision,
              Revision pegRevision,
              boolean force,
              boolean ignoreExternals,
              boolean recurse,
              java.lang.String nativeEOL)
              throws ClientException
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 exported
destPath - a destination path that must not already exist.
revision - the revsion to be exported
pegRevision - the revision to interpret srcPath
force - set if it is ok to overwrite local files
ignoreExternals - ignore external during export
recurse - recurse to subdirectories
nativeEOL - which EOL characters to use during export
Throws:
ClientException
Since:
1.2

doSwitch

long doSwitch(java.lang.String path,
              java.lang.String url,
              Revision revision,
              boolean recurse)
              throws ClientException
Update local copy to mirror a new url.

Parameters:
path - the working copy path
url - the new url for the working copy
revision - the new base revision of working copy
recurse - traverse into subdirectories
Throws:
ClientException

doImport

void doImport(java.lang.String path,
              java.lang.String url,
              java.lang.String message,
              boolean recurse)
              throws ClientException
Import a file or directory into a repository directory at head.

Parameters:
path - the local path
url - the target url
message - the log message.
recurse - traverse into subdirectories
Throws:
ClientException

merge

void merge(java.lang.String path1,
           Revision revision1,
           java.lang.String path2,
           Revision revision2,
           java.lang.String localPath,
           boolean force,
           boolean recurse)
           throws ClientException
Merge changes from two paths into a new local path.

Parameters:
path1 - first path or url
revision1 - first revision
path2 - second path or url
revision2 - second revision
localPath - target local path
force - overwrite local changes
recurse - traverse into subdirectories
Throws:
ClientException

merge

void merge(java.lang.String path1,
           Revision revision1,
           java.lang.String path2,
           Revision revision2,
           java.lang.String localPath,
           boolean force,
           boolean recurse,
           boolean ignoreAncestry,
           boolean dryRun)
           throws ClientException
Merge changes from two paths into a new local path.

Parameters:
path1 - first path or url
revision1 - first revision
path2 - second path or url
revision2 - second revision
localPath - target local path
force - overwrite local changes
recurse - traverse into subdirectories
ignoreAncestry - ignore if files are not related
dryRun - do not change anything
Throws:
ClientException
Since:
1.2

merge

void merge(java.lang.String path,
           Revision pegRevision,
           Revision revision1,
           Revision revision2,
           java.lang.String localPath,
           boolean force,
           boolean recurse,
           boolean ignoreAncestry,
           boolean dryRun)
           throws ClientException
Merge changes from two paths into a new local path.

Parameters:
path - path or url
pegRevision - revision to interpret path
revision1 - first revision
revision2 - second revision
localPath - target local path
force - overwrite local changes
recurse - traverse into subdirectories
ignoreAncestry - ignore if files are not related
dryRun - do not change anything
Throws:
ClientException
Since:
1.2

diff

void diff(java.lang.String target1,
          Revision revision1,
          java.lang.String target2,
          Revision revision2,
          java.lang.String outFileName,
          boolean recurse)
          throws ClientException
Display the differences between two paths

Parameters:
target1 - first path or url
revision1 - first revision
target2 - second path or url
revision2 - second revision
outFileName - file name where difference are written
recurse - traverse into subdirectories
Throws:
ClientException

diff

void diff(java.lang.String target1,
          Revision revision1,
          java.lang.String target2,
          Revision revision2,
          java.lang.String outFileName,
          boolean recurse,
          boolean ignoreAncestry,
          boolean noDiffDeleted,
          boolean force)
          throws ClientException
Display the differences between two paths

Parameters:
target1 - first path or url
revision1 - first revision
target2 - second path or url
revision2 - second revision
outFileName - file name where difference are written
recurse - traverse into subdirectories
ignoreAncestry - ignore if files are not related
noDiffDeleted - no output on deleted files
force - diff even on binary files
Throws:
ClientException
Since:
1.2

diff

void diff(java.lang.String target,
          Revision pegRevision,
          Revision startRevision,
          Revision endRevision,
          java.lang.String outFileName,
          boolean recurse,
          boolean ignoreAncestry,
          boolean noDiffDeleted,
          boolean force)
          throws ClientException
Display the differences between two paths

Parameters:
target - path or url
pegRevision - revision tointerpret target
startRevision - first Revision to compare
endRevision - second Revision to compare
outFileName - file name where difference are written
recurse - traverse into subdirectories
ignoreAncestry - ignore if files are not related
noDiffDeleted - no output on deleted files
force - diff even on binary files
Throws:
ClientException
Since:
1.2

properties

PropertyData[] properties(java.lang.String path)
                          throws ClientException
Retrieves the properties of an item

Parameters:
path - the path of the item
Returns:
array of property objects
Throws:
ClientException

properties

PropertyData[] properties(java.lang.String path,
                          Revision revision)
                          throws ClientException
Retrieves the properties of an item

Parameters:
path - the path of the item
revision - the revision of the item
Returns:
array of property objects
Throws:
ClientException
Since:
1.2

properties

PropertyData[] properties(java.lang.String path,
                          Revision revision,
                          Revision pegRevision)
                          throws ClientException
Retrieves the properties of an item

Parameters:
path - the path of the item
revision - the revision of the item
pegRevision - the revision to interpret path
Returns:
array of property objects
Throws:
ClientException
Since:
1.2

propertySet

void propertySet(java.lang.String path,
                 java.lang.String name,
                 java.lang.String value,
                 boolean recurse)
                 throws ClientException
Sets one property of an item with a String value

Parameters:
path - path of the item
name - name of the property
value - new value of the property
recurse - set property also on the subdirectories
Throws:
ClientException

propertySet

void propertySet(java.lang.String path,
                 java.lang.String name,
                 java.lang.String value,
                 boolean recurse,
                 boolean force)
                 throws ClientException
Sets one property of an item with a String value

Parameters:
path - path of the item
name - name of the property
value - new value of the property
recurse - set property also on the subdirectories
force - do not check if the value is valid
Throws:
ClientException
Since:
1.2

propertySet

void propertySet(java.lang.String path,
                 java.lang.String name,
                 byte[] value,
                 boolean recurse)
                 throws ClientException
Sets one property of an item with a byte array value

Parameters:
path - path of the item
name - name of the property
value - new value of the property
recurse - set property also on the subdirectories
Throws:
ClientException

propertySet

void propertySet(java.lang.String path,
                 java.lang.String name,
                 byte[] value,
                 boolean recurse,
                 boolean force)
                 throws ClientException
Sets one property of an item with a byte array value

Parameters:
path - path of the item
name - name of the property
value - new value of the property
recurse - set property also on the subdirectories
force - do not check if the value is valid
Throws:
ClientException
Since:
1.2

propertyRemove

void propertyRemove(java.lang.String path,
                    java.lang.String name,
                    boolean recurse)
                    throws ClientException
Remove one property of an item.

Parameters:
path - path of the item
name - name of the property
recurse - remove the property also on subdirectories
Throws:
ClientException

propertyCreate

void propertyCreate(java.lang.String path,
                    java.lang.String name,
                    java.lang.String value,
                    boolean recurse)
                    throws ClientException
Create and sets one property of an item with a String value

Parameters:
path - path of the item
name - name of the property
value - new value of the property
recurse - set property also on the subdirectories
Throws:
ClientException

propertyCreate

void propertyCreate(java.lang.String path,
                    java.lang.String name,
                    java.lang.String value,
                    boolean recurse,
                    boolean force)
                    throws ClientException
Create and sets one property of an item with a String value

Parameters:
path - path of the item
name - name of the property
value - new value of the property
recurse - set property also on the subdirectories
force - do not check if the value is valid
Throws:
ClientException
Since:
1.2

propertyCreate

void propertyCreate(java.lang.String path,
                    java.lang.String name,
                    byte[] value,
                    boolean recurse)
                    throws ClientException
Create and sets one property of an item with a byte array value

Parameters:
path - path of the item
name - name of the property
value - new value of the property
recurse - set property also on the subdirectories
Throws:
ClientException

propertyCreate

void propertyCreate(java.lang.String path,
                    java.lang.String name,
                    byte[] value,
                    boolean recurse,
                    boolean force)
                    throws ClientException
Create and sets one property of an item with a byte array value

Parameters:
path - path of the item
name - name of the property
value - new value of the property
recurse - set property also on the subdirectories
force - do not check if the value is valid
Throws:
ClientException
Since:
1.2

revProperty

PropertyData revProperty(java.lang.String path,
                         java.lang.String name,
                         Revision rev)
                         throws ClientException
Retrieve one revsision property of one item

Parameters:
path - path of the item
name - name of the property
rev - revision to retrieve
Returns:
the Property
Throws:
ClientException

revProperties

PropertyData[] revProperties(java.lang.String path,
                             Revision rev)
                             throws ClientException
Retrieve all revsision properties of one item

Parameters:
path - path of the item
rev - revision to retrieve
Returns:
the Properties
Throws:
ClientException
Since:
1.2

setRevProperty

void setRevProperty(java.lang.String path,
                    java.lang.String name,
                    Revision rev,
                    java.lang.String value,
                    boolean force)
                    throws ClientException
set one revsision property of one item

Parameters:
path - path of the item
name - name of the property
rev - revision to retrieve
value - value of the property
force - use force to set
Throws:
ClientException
Since:
1.2

propertyGet

PropertyData propertyGet(java.lang.String path,
                         java.lang.String name)
                         throws ClientException
Retrieve one property of one iten

Parameters:
path - path of the item
name - name of property
Returns:
the Property
Throws:
ClientException

propertyGet

PropertyData propertyGet(java.lang.String path,
                         java.lang.String name,
                         Revision revision)
                         throws ClientException
Retrieve one property of one iten

Parameters:
path - path of the item
name - name of property
revision - revision of the item
Returns:
the Property
Throws:
ClientException
Since:
1.2

propertyGet

PropertyData propertyGet(java.lang.String path,
                         java.lang.String name,
                         Revision revision,
                         Revision pegRevision)
                         throws ClientException
Retrieve one property of one iten

Parameters:
path - path of the item
name - name of property
revision - revision of the item
pegRevision - the revision to interpret path
Returns:
the Property
Throws:
ClientException
Since:
1.2

fileContent

byte[] fileContent(java.lang.String path,
                   Revision revision)
                   throws ClientException
Retrieve the content of a file

Parameters:
path - the path of the file
revision - the revision to retrieve
Returns:
the content as byte array
Throws:
ClientException

fileContent

byte[] fileContent(java.lang.String path,
                   Revision revision,
                   Revision pegRevision)
                   throws ClientException
Retrieve the content of a file

Parameters:
path - the path of the file
revision - the revision to retrieve
pegRevision - the revision to interpret path
Returns:
the content as byte array
Throws:
ClientException
Since:
1.2

streamFileContent

void streamFileContent(java.lang.String path,
                       Revision revision,
                       Revision pegRevision,
                       int bufferSize,
                       java.io.OutputStream stream)
                       throws ClientException
Write 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 file
revision - the revision to retrieve
pegRevision - the revision at which to interpret the path
the - stream to write the file's content to
Throws:
ClientException
See Also:
PipedOutputStream, PipedInputStream

relocate

void relocate(java.lang.String from,
              java.lang.String to,
              java.lang.String path,
              boolean recurse)
              throws ClientException
Rewrite the url's in the working copy

Parameters:
from - old url
to - new url
path - working copy path
recurse - recurse into subdirectories
Throws:
ClientException

blame

byte[] blame(java.lang.String path,
             Revision revisionStart,
             Revision revisionEnd)
             throws ClientException
Deprecated. 

Return for each line of the file, the author and the revision of the last together with the content.

Parameters:
path - the path
revisionStart - the first revision to show
revisionEnd - the last revision to show
Returns:
the content together with author and revision of last change
Throws:
ClientException

blame

void blame(java.lang.String path,
           Revision revisionStart,
           Revision revisionEnd,
           BlameCallback callback)
           throws ClientException
Retrieve the content together with the author, the revision and the date of the last change of each line

Parameters:
path - the path
revisionStart - the first revision to show
revisionEnd - the last revision to show
callback - callback to receive the file content and the other information
Throws:
ClientException

blame

void blame(java.lang.String path,
           Revision pegRevision,
           Revision revisionStart,
           Revision revisionEnd,
           BlameCallback callback)
           throws ClientException
Retrieve the content together with the author, the revision and the date of the last change of each line

Parameters:
path - the path
pegRevision - the revision to interpret the path
revisionStart - the first revision to show
revisionEnd - the last revision to show
callback - callback to receive the file content and the other information
Throws:
ClientException
Since:
1.2

setConfigDirectory

void setConfigDirectory(java.lang.String configDir)
                        throws ClientException
Set directory for the configuration information, taking the usual steps to ensure that Subversion's config file templates exist in the specified location.

Parameters:
configDir - path of the directory
Throws:
ClientException

getConfigDirectory

java.lang.String getConfigDirectory()
                                    throws ClientException
Get the configuration directory

Returns:
the directory
Throws:
ClientException

cancelOperation

void cancelOperation()
                     throws ClientException
cancel the active operation

Throws:
ClientException

info

Info info(java.lang.String path)
          throws ClientException
Retrieves the working copy information for an item

Parameters:
path - path of the item
Returns:
the information object
Throws:
ClientException

lock

void lock(java.lang.String[] path,
          java.lang.String comment,
          boolean force)
          throws ClientException
Lock a working copy item

Parameters:
path - path of the item
comment -
force - break an existing lock
Throws:
ClientException
Since:
1.2

unlock

void unlock(java.lang.String[] path,
            boolean force)
            throws ClientException
Unlock a working copy item

Parameters:
path - path of the item
force - break an existing lock
Throws:
ClientException
Since:
1.2

info2

Info2[] info2(java.lang.String pathOrUrl,
              Revision revision,
              Revision pegRevision,
              boolean recurse)
              throws ClientException
Retrieve information about repository or working copy items.

Parameters:
pathOrUrl - the path or the url of the item
revision - the revision of the item to return
pegRevision - the revision to interpret pathOrUrl
recurse - flag if to recurse, if the item is a directory
Returns:
the information objects
Throws:
ClientException
Since:
1.2

getVersionInfo

java.lang.String getVersionInfo(java.lang.String path,
                                java.lang.String trailUrl,
                                boolean lastChanged)
                                throws ClientException
Produce a compact "version number" for a working copy

Parameters:
path - path of the working copy
trailUrl - to detect switches of the whole working copy
lastChanged - last changed rather than current revisions
Returns:
the compact "version number"
Throws:
ClientException
Since:
1.2