org.tigris.subversion.svnclientadapter
Interface ISVNClientAdapter

All Known Implementing Classes:
AbstractClientAdapter

public interface ISVNClientAdapter

High level API for Subversion


Field Summary
static java.lang.String[] DEFAULT_LOG_PROPERTIES
           
static java.lang.String REPOSITORY_FSTYPE_BDB
          constant identifying the "bdb" repository type
static java.lang.String REPOSITORY_FSTYPE_FSFS
          constant identifying the "fsfs" repository type
 
Method Summary
 void addConflictResolutionCallback(ISVNConflictResolver callback)
          Add a callback for resolving conflicts during up/sw/merge
 void addDirectory(java.io.File dir, boolean recurse)
          Adds a directory to the repository.
 void addDirectory(java.io.File dir, boolean recurse, boolean force)
          Adds a directory to the repository.
 void addFile(java.io.File file)
          Adds a file (or directory) to the repository.
 SVNKeywords addKeywords(java.io.File path, SVNKeywords keywords)
          add some keyword to the keywords substitution list
 void addNotifyListener(ISVNNotifyListener listener)
          Add a notification listener
 void addPasswordCallback(ISVNPromptUserPassword callback)
          Add a callback for prompting for username, password SSL etc...
 void addToIgnoredPatterns(java.io.File path, java.lang.String pattern)
          add a pattern to svn:ignore property
 ISVNAnnotations annotate(java.io.File file, SVNRevision revisionStart, SVNRevision revisionEnd)
          Output the content of specified file with revision and author information in-line.
 ISVNAnnotations annotate(java.io.File file, SVNRevision revisionStart, SVNRevision revisionEnd, boolean ignoreMimeType, boolean includeMergedRevisions)
          Output the content of specified file with revision and author information in-line.
 ISVNAnnotations annotate(java.io.File file, SVNRevision revisionStart, SVNRevision revisionEnd, SVNRevision pegRevision, boolean ignoreMimeType, boolean includeMergedRevisions)
          Output the content of specified file with revision and author information in-line.
 ISVNAnnotations annotate(SVNUrl url, SVNRevision revisionStart, SVNRevision revisionEnd)
          Output the content of specified url with revision and author information in-line.
 ISVNAnnotations annotate(SVNUrl url, SVNRevision revisionStart, SVNRevision revisionEnd, SVNRevision pegRevision, boolean ignoreMimeType, boolean includeMergedRevisions)
          Output the content of specified url with revision and author information in-line.
 void cancelOperation()
          Cancel the current operation
 boolean canCommitAcrossWC()
          Indicates whether the commitAcrossWC method is supported in the adapter
 void checkout(SVNUrl moduleName, java.io.File destPath, SVNRevision revision, boolean recurse)
          Executes a revision checkout.
 void checkout(SVNUrl moduleName, java.io.File destPath, SVNRevision revision, int depth, boolean ignoreExternals, boolean force)
          Executes a revision checkout.
 void cleanup(java.io.File dir)
          Perform a clanup on the working copy.
 long commit(java.io.File[] paths, java.lang.String message, boolean recurse)
          Commits changes to the repository.
 long commit(java.io.File[] paths, java.lang.String message, boolean recurse, boolean keepLocks)
          Commits changes to the repository.
 long[] commitAcrossWC(java.io.File[] paths, java.lang.String message, boolean recurse, boolean keepLocks, boolean atomic)
          Commits changes to the repository.
 void copy(java.io.File[] srcPaths, SVNUrl destUrl, java.lang.String message, boolean copyAsChild, boolean makeParents)
          immediately commit a copy of WC to URL
 void copy(java.io.File srcPath, java.io.File destPath)
          copy and schedule for addition (with history)
 void copy(java.io.File srcPath, SVNUrl destUrl, java.lang.String message)
          immediately commit a copy of WC to URL
 void copy(SVNUrl[] srcUrls, SVNUrl destUrl, java.lang.String message, SVNRevision revision, boolean copyAsChild, boolean makeParents)
          complete server-side copy with option to create intermediate folders; used to branch & tag
 void copy(SVNUrl srcUrl, java.io.File destPath, SVNRevision revision)
          check out URL into WC, schedule for addition
 void copy(SVNUrl srcUrl, java.io.File destPath, SVNRevision revision, boolean copyAsChild, boolean makeParents)
          check out URL into WC, schedule for addition
 void copy(SVNUrl srcUrl, java.io.File destPath, SVNRevision revision, SVNRevision pegRevision, boolean copyAsChild, boolean makeParents)
          check out URL into WC, schedule for addition
 void copy(SVNUrl srcUrl, SVNUrl destUrl, java.lang.String message, SVNRevision revision)
          complete server-side copy; used to branch & tag
 void copy(SVNUrl srcUrl, SVNUrl destUrl, java.lang.String message, SVNRevision revision, boolean makeParents)
          complete server-side copy with option to create intermediate folders; used to branch & tag
 void createPatch(java.io.File[] paths, java.io.File relativeToPath, java.io.File outFile, boolean recurse)
          create a patch from local differences.
 void createRepository(java.io.File path, java.lang.String repositoryType)
          Create a new, empty repository at path
 void diff(java.io.File[] paths, java.io.File outFile, boolean recurse)
          display the combined differences for an array of paths.
 void diff(java.io.File path, java.io.File outFile, boolean recurse)
          display the differences between two paths.
 void diff(java.io.File oldPath, SVNRevision oldPathRevision, java.io.File newPath, SVNRevision newPathRevision, java.io.File outFile, boolean recurse)
          display the differences between two paths.
 void diff(java.io.File oldPath, SVNRevision oldPathRevision, java.io.File newPath, SVNRevision newPathRevision, java.io.File outFile, boolean recurse, boolean ignoreAncestry, boolean noDiffDeleted, boolean force)
          display the differences between two paths.
 void diff(java.io.File path, SVNUrl url, SVNRevision urlRevision, java.io.File outFile, boolean recurse)
          display the differences between WC and url.
 void diff(SVNUrl url, SVNRevision oldUrlRevision, SVNRevision newUrlRevision, java.io.File outFile, boolean recurse)
          display the differences between two urls.
 void diff(SVNUrl target, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, java.io.File outFile, boolean recurse)
          Display the differences between two paths.
 void diff(SVNUrl target, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, java.io.File outFile, int depth, boolean ignoreAncestry, boolean noDiffDeleted, boolean force)
          Display the differences between two paths.
 void diff(SVNUrl oldUrl, SVNRevision oldUrlRevision, SVNUrl newUrl, SVNRevision newUrlRevision, java.io.File outFile, boolean recurse)
          display the differences between two urls.
 void diff(SVNUrl oldUrl, SVNRevision oldUrlRevision, SVNUrl newUrl, SVNRevision newUrlRevision, java.io.File outFile, boolean recurse, boolean ignoreAncestry, boolean noDiffDeleted, boolean force)
          display the differences between two urls.
 SVNDiffSummary[] diffSummarize(java.io.File path, SVNUrl toUrl, SVNRevision toRevision, boolean recurse)
           
 SVNDiffSummary[] diffSummarize(SVNUrl target, SVNRevision pegRevision, SVNRevision startRevision, SVNRevision endRevision, int depth, boolean ignoreAncestry)
          Produce a diff summary which lists the items changed between path and revision pairs.
 SVNDiffSummary[] diffSummarize(SVNUrl target1, SVNRevision revision1, SVNUrl target2, SVNRevision revision2, int depth, boolean ignoreAncestry)
          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)
 void doExport(java.io.File srcPath, java.io.File destPath, boolean force)
          Exports a clean directory tree from the working copy specified by PATH1 into PATH2.
 void doExport(SVNUrl srcUrl, java.io.File destPath, SVNRevision revision, boolean force)
          Exports a clean directory tree from the repository specified by srcUrl, at revision revision
 void doImport(java.io.File path, SVNUrl url, java.lang.String message, boolean recurse)
          Import file or directory PATH into repository directory URL at head
 java.lang.String getAdminDirectoryName()
          Returns the name of the Subversion administrative working copy directory.
 java.io.InputStream getContent(java.io.File path, SVNRevision revision)
          get the content of a file
 java.io.InputStream getContent(SVNUrl url, SVNRevision revision)
          get the content of a file
 java.io.InputStream getContent(SVNUrl url, SVNRevision revision, SVNRevision pegRevision)
          get the content of a file
 ISVNDirEntry getDirEntry(java.io.File path, SVNRevision revision)
          get the dirEntry for the given directory
 ISVNDirEntry getDirEntry(SVNUrl url, SVNRevision revision)
          get the dirEntry for the given url
 java.util.List getIgnoredPatterns(java.io.File path)
          get the ignored patterns for the given directory if path is not a directory, returns null
 ISVNInfo getInfo(java.io.File file)
          Get information about a file or directory.
 ISVNInfo[] getInfo(java.io.File file, boolean descend)
          Get information about a file or directory.
 ISVNInfo getInfo(SVNUrl url)
          Get information about an URL.
 ISVNInfo getInfo(SVNUrl url, SVNRevision revision, SVNRevision peg)
          Get information about an URL.
 ISVNInfo getInfoFromWorkingCopy(java.io.File file)
          Get information about a file or directory from working copy.
 SVNKeywords getKeywords(java.io.File path)
          returns the keywords used for substitution for the given resource
 ISVNDirEntry[] getList(java.io.File path, SVNRevision revision, boolean recurse)
          List directory entries of a directory
 ISVNDirEntry[] getList(java.io.File path, SVNRevision revision, SVNRevision pegRevision, boolean recurse)
          List directory entries of a directory
 ISVNDirEntry[] getList(SVNUrl url, SVNRevision revision, boolean recurse)
          List directory entries of a URL
 ISVNDirEntry[] getList(SVNUrl url, SVNRevision revision, SVNRevision pegRevision, boolean recurse)
          List directory entries of a URL
 ISVNDirEntryWithLock[] getListWithLocks(SVNUrl url, SVNRevision revision, SVNRevision pegRevision, boolean recurse)
          List directory entries of a URL with lock information
 ISVNLogMessage[] getLogMessages(java.io.File path, SVNRevision revisionStart, SVNRevision revisionEnd)
          Get the log messages for a set of revision(s)
 ISVNLogMessage[] getLogMessages(java.io.File path, SVNRevision revisionStart, SVNRevision revisionEnd, boolean fetchChangePath)
          Get the log messages for a set of revision(s)
 ISVNLogMessage[] getLogMessages(java.io.File path, SVNRevision revisionStart, SVNRevision revisionEnd, boolean stopOnCopy, boolean fetchChangePath)
          Retrieve the log messages for an item
 ISVNLogMessage[] getLogMessages(java.io.File path, SVNRevision revisionStart, SVNRevision revisionEnd, boolean stopOnCopy, boolean fetchChangePath, long limit)
          Retrieve the log messages for an item
 ISVNLogMessage[] getLogMessages(java.io.File path, SVNRevision pegRevision, SVNRevision revisionStart, SVNRevision revisionEnd, boolean stopOnCopy, boolean fetchChangePath, long limit, boolean includeMergedRevisions)
          Retrieve the log messages for an item
 void getLogMessages(java.io.File path, SVNRevision pegRevision, SVNRevision revisionStart, SVNRevision revisionEnd, boolean stopOnCopy, boolean fetchChangePath, long limit, boolean includeMergedRevisions, java.lang.String[] requestedProperties, ISVNLogMessageCallback callback)
          Retrieve the log messages for an item
 ISVNLogMessage[] getLogMessages(SVNUrl url, java.lang.String[] paths, SVNRevision revStart, SVNRevision revEnd, boolean stopOnCopy, boolean fetchChangePath)
          Get the log messages for a set paths and revision(s)
 ISVNLogMessage[] getLogMessages(SVNUrl url, SVNRevision revisionStart, SVNRevision revisionEnd)
          Get the log messages for a set of revision(s)
 ISVNLogMessage[] getLogMessages(SVNUrl url, SVNRevision revisionStart, SVNRevision revisionEnd, boolean fetchChangePath)
          Get the log messages for a set of revision(s)
 ISVNLogMessage[] getLogMessages(SVNUrl url, SVNRevision pegRevision, SVNRevision revisionStart, SVNRevision revisionEnd, boolean stopOnCopy, boolean fetchChangePath, long limit)
          Retrieve the log messages for an item
 ISVNLogMessage[] getLogMessages(SVNUrl url, SVNRevision pegRevision, SVNRevision revisionStart, SVNRevision revisionEnd, boolean stopOnCopy, boolean fetchChangePath, long limit, boolean includeMergedRevisions)
          Retrieve the log messages for an item
 void getLogMessages(SVNUrl url, SVNRevision pegRevision, SVNRevision revisionStart, SVNRevision revisionEnd, boolean stopOnCopy, boolean fetchChangePath, long limit, boolean includeMergedRevisions, java.lang.String[] requestedProperties, ISVNLogMessageCallback callback)
          Retrieve the log messages for an item
 ISVNMergeInfo getMergeInfo(java.io.File path, SVNRevision revision)
          Get merge info for path at revision.
 ISVNMergeInfo getMergeInfo(SVNUrl url, SVNRevision revision)
          Get merge info for url at revision.
 ISVNLogMessage[] getMergeinfoLog(int kind, java.io.File path, SVNRevision pegRevision, SVNUrl mergeSourceUrl, SVNRevision srcPegRevision, boolean discoverChangedPaths)
          Retrieve either merged or eligible-to-be-merged revisions.
 ISVNLogMessage[] getMergeinfoLog(int kind, SVNUrl url, SVNRevision pegRevision, SVNUrl mergeSourceUrl, SVNRevision srcPegRevision, boolean discoverChangedPaths)
          Retrieve either merged or eligible-to-be-merged revisions.
 SVNNotificationHandler getNotificationHandler()
           
 ISVNProperty[] getProperties(java.io.File path)
          Get all the properties for the given file or dir
 ISVNProperty[] getProperties(SVNUrl url)
          Get all the properties for the given url
 ISVNProperty[] getProperties(SVNUrl url, SVNRevision revision, SVNRevision peg)
          Get all the properties for the given url
 ISVNProperty[] getRevProperties(SVNUrl url, SVNRevision.Number revision)
          Get all the revision properties for the given url at a revision
 java.lang.String getRevProperty(SVNUrl path, SVNRevision.Number revisionNo, java.lang.String propName)
          get a revision property for a given revision
 ISVNStatus getSingleStatus(java.io.File path)
          Returns the status of a single file in the path.
 ISVNStatus[] getStatus(java.io.File[] path)
          Returns the status of given resources
 ISVNStatus[] getStatus(java.io.File path, boolean descend, boolean getAll)
          Returns the status of path and its children.
 ISVNStatus[] getStatus(java.io.File path, boolean descend, boolean getAll, boolean contactServer)
          Returns the status of path and its children.
 ISVNStatus[] getStatus(java.io.File path, boolean descend, boolean getAll, boolean contactServer, boolean ignoreExternals)
          Returns the status of path and its children.
 boolean isAdminDirectory(java.lang.String name)
          Returns whether the passed folder name is a Subversion administrative working copy directory.
 boolean isThreadsafe()
          Returns whether the client adapter implementation is threadsafe
 void lock(java.io.File[] paths, java.lang.String comment, boolean force)
          Lock a working copy item
 void lock(SVNUrl[] paths, java.lang.String comment, boolean force)
          Lock a working copy item
 void merge(SVNUrl url, SVNRevision pegRevision, SVNRevisionRange[] revisions, java.io.File localPath, boolean force, int depth, boolean ignoreAncestry, boolean dryRun, boolean recordOnly)
          Merge set of revisions into a new local path.
 void merge(SVNUrl path1, SVNRevision revision1, SVNUrl path2, SVNRevision revision2, java.io.File localPath, boolean force, boolean recurse)
          Merge changes from two paths into a new local path.
 void merge(SVNUrl path1, SVNRevision revision1, SVNUrl path2, SVNRevision revision2, java.io.File localPath, boolean force, boolean recurse, boolean dryRun)
          Merge changes from two paths into a new local path.
 void merge(SVNUrl path1, SVNRevision revision1, SVNUrl path2, SVNRevision revision2, java.io.File localPath, boolean force, boolean recurse, boolean dryRun, boolean ignoreAncestry)
          Merge changes from two paths into a new local path.
 void merge(SVNUrl path1, SVNRevision revision1, SVNUrl path2, SVNRevision revision2, java.io.File localPath, boolean force, int depth, boolean dryRun, boolean ignoreAncestry, boolean recordOnly)
          Merge changes from two paths into a new local path.
 void mergeReintegrate(SVNUrl path, SVNRevision pegRevision, java.io.File localPath, boolean force, boolean dryRun)
          Perform a reintegration merge of path into localPath.
 void mkdir(java.io.File file)
          creates a directory on disk and schedules it for addition.
 void mkdir(SVNUrl url, boolean makeParents, java.lang.String message)
          Creates a directory directly in a repository
 void mkdir(SVNUrl url, java.lang.String message)
          Creates a directory directly in a repository
 void move(java.io.File srcPath, java.io.File destPath, boolean force)
          Moves or renames a file.
 void move(SVNUrl srcUrl, SVNUrl destUrl, java.lang.String message, SVNRevision revision)
          Moves or renames a file.
 void propertyDel(java.io.File path, java.lang.String propertyName, boolean recurse)
          delete a property
 ISVNProperty propertyGet(java.io.File path, java.lang.String propertyName)
          get a property or null if property is not found
 ISVNProperty propertyGet(SVNUrl url, java.lang.String propertyName)
          get a property or null if property is not found
 ISVNProperty propertyGet(SVNUrl url, SVNRevision revision, SVNRevision peg, java.lang.String propertyName)
          get a property or null if property is not found
 void propertySet(java.io.File path, java.lang.String propertyName, java.io.File propertyFile, boolean recurse)
          set a property using the content of a file
 void propertySet(java.io.File path, java.lang.String propertyName, java.lang.String propertyValue, boolean recurse)
          set a property
 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.io.File[] file, boolean force)
          the item is scheduled for deletion upon the next commit.
 void remove(SVNUrl[] url, java.lang.String message)
          item is deleted from the repository via an immediate commit.
 SVNKeywords removeKeywords(java.io.File path, SVNKeywords keywords)
          remove some keywords to the keywords substitution list
 void removeNotifyListener(ISVNNotifyListener listener)
          Remove a notification listener
 void resolve(java.io.File path, int result)
          Remove 'conflicted' state on working copy files or directories
 void resolved(java.io.File path)
          Remove 'conflicted' state on working copy files or directories
 void revert(java.io.File path, boolean recurse)
          Restore pristine working copy file (undo all local edits)
 void setConfigDirectory(java.io.File dir)
          Set the configuration directory.
 void setIgnoredPatterns(java.io.File path, java.util.List patterns)
          set the ignored patterns for the given directory
 void setKeywords(java.io.File path, SVNKeywords keywords, boolean recurse)
          set the keywords substitution for the given resource
 void setPassword(java.lang.String password)
          Sets the password.
 void setProgressListener(ISVNProgressListener progressListener)
          Set a progress listener
 void setRevProperty(SVNUrl path, SVNRevision.Number revisionNo, java.lang.String propName, java.lang.String propertyData, boolean force)
          set the revision property for a given revision
 void setUsername(java.lang.String username)
          Sets the username.
 boolean statusReturnsRemoteInfo()
          Indicates whether a status call that contacts the server includes the remote info in the status object
 java.lang.String[] suggestMergeSources(java.io.File path)
          Return an ordered list of suggested merge source URLs.
 java.lang.String[] suggestMergeSources(SVNUrl url, SVNRevision peg)
          Return an ordered list of suggested merge source URLs.
 void switchToUrl(java.io.File path, SVNUrl url, SVNRevision revision, boolean recurse)
          Update the working copy to mirror a new URL within the repository.
 void switchToUrl(java.io.File path, SVNUrl url, SVNRevision revision, int depth, boolean setDepth, boolean ignoreExternals, boolean force)
          Update the working copy to mirror a new URL within the repository.
 void switchToUrl(java.io.File path, SVNUrl url, SVNRevision revision, SVNRevision pegRevision, int depth, boolean setDepth, boolean ignoreExternals, boolean force)
          Update the working copy to mirror a new URL within the repository.
 void unlock(java.io.File[] paths, boolean force)
          Unlock a working copy item
 void unlock(SVNUrl[] paths, boolean force)
          Unlock a working copy item
 long[] update(java.io.File[] path, SVNRevision revision, boolean recurse, boolean ignoreExternals)
          Updates the directories or files from repository
 long[] update(java.io.File[] path, SVNRevision revision, int depth, boolean setDepth, boolean ignoreExternals, boolean force)
          Updates the directories or files from repository
 long update(java.io.File path, SVNRevision revision, boolean recurse)
          Update a file or a directory
 long update(java.io.File path, SVNRevision revision, int depth, boolean setDepth, boolean ignoreExternals, boolean force)
          Update a file or a directory
 

Field Detail

REPOSITORY_FSTYPE_BDB

static final java.lang.String REPOSITORY_FSTYPE_BDB
constant identifying the "bdb" repository type

See Also:
Constant Field Values

REPOSITORY_FSTYPE_FSFS

static final java.lang.String REPOSITORY_FSTYPE_FSFS
constant identifying the "fsfs" repository type

See Also:
Constant Field Values

DEFAULT_LOG_PROPERTIES

static final java.lang.String[] DEFAULT_LOG_PROPERTIES
Method Detail

isThreadsafe

boolean isThreadsafe()
Returns whether the client adapter implementation is threadsafe


addNotifyListener

void addNotifyListener(ISVNNotifyListener listener)
Add a notification listener

Parameters:
listener -

removeNotifyListener

void removeNotifyListener(ISVNNotifyListener listener)
Remove a notification listener

Parameters:
listener -

getNotificationHandler

SVNNotificationHandler getNotificationHandler()
Returns:
the notification handler

setUsername

void setUsername(java.lang.String username)
Sets the username.

Parameters:
username -

setPassword

void setPassword(java.lang.String password)
Sets the password.

Parameters:
password -

addPasswordCallback

void addPasswordCallback(ISVNPromptUserPassword callback)
Add a callback for prompting for username, password SSL etc...

Parameters:
callback -

addConflictResolutionCallback

void addConflictResolutionCallback(ISVNConflictResolver callback)
Add a callback for resolving conflicts during up/sw/merge

Parameters:
callback -

setProgressListener

void setProgressListener(ISVNProgressListener progressListener)
Set a progress listener

Parameters:
progressListener -

addFile

void addFile(java.io.File file)
             throws SVNClientException
Adds a file (or directory) to the repository.

Parameters:
file -
Throws:
SVNClientException

addDirectory

void addDirectory(java.io.File dir,
                  boolean recurse)
                  throws SVNClientException
Adds a directory to the repository.

Parameters:
dir -
recurse -
Throws:
SVNClientException

addDirectory

void addDirectory(java.io.File dir,
                  boolean recurse,
                  boolean force)
                  throws SVNClientException
Adds a directory to the repository.

Parameters:
dir -
recurse -
force -
Throws:
SVNClientException

checkout

void checkout(SVNUrl moduleName,
              java.io.File destPath,
              SVNRevision revision,
              boolean recurse)
              throws SVNClientException
Executes a revision checkout.

Parameters:
moduleName - name of the module to checkout.
destPath - destination directory for checkout.
revision - the revision number to checkout. If the number is -1 then it will checkout the latest revision.
recurse - whether you want it to checkout files recursively.
Throws:
SVNClientException

checkout

void checkout(SVNUrl moduleName,
              java.io.File destPath,
              SVNRevision revision,
              int depth,
              boolean ignoreExternals,
              boolean force)
              throws SVNClientException
Executes a revision checkout.

Parameters:
moduleName - name of the module to checkout.
destPath - destination directory for checkout.
revision - the revision number to checkout. If the number is -1 then it will checkout the latest revision.
depth - how deep to checkout files recursively.
ignoreExternals - if externals are ignored during checkout.
force - allow unversioned paths that obstruct adds.
Throws:
SVNClientException

commit

long commit(java.io.File[] paths,
            java.lang.String message,
            boolean recurse)
            throws SVNClientException
Commits changes to the repository. This usually requires authentication, see Auth.

Parameters:
paths - 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:
SVNClientException

commit

long commit(java.io.File[] paths,
            java.lang.String message,
            boolean recurse,
            boolean keepLocks)
            throws SVNClientException
Commits changes to the repository. This usually requires authentication, see Auth.

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

commitAcrossWC

long[] commitAcrossWC(java.io.File[] paths,
                      java.lang.String message,
                      boolean recurse,
                      boolean keepLocks,
                      boolean atomic)
                      throws SVNClientException
Commits changes to the repository. This usually requires authentication, see Auth. This differs from the normal commit method in that it can accept paths from more than one working copy.

Parameters:
paths - files to commit.
message - log message.
recurse - whether the operation should be done recursively.
keepLocks - whether to keep locks on files that are committed.
atomic - whether to attempt to perform the commit from multiple working copies atomically. Files from the same repository will be processed with one commit operation. If files span multiple repositories they will be processed in multiple commits. When atomic is false, you will get one commit per WC.
Returns:
Returns an array of longs representing the revisions. It returns a -1 if the revision number is invalid.
Throws:
SVNClientException

getList

ISVNDirEntry[] getList(SVNUrl url,
                       SVNRevision revision,
                       boolean recurse)
                       throws SVNClientException
List directory entries of a URL

Parameters:
url -
revision -
recurse -
Returns:
an array of ISVNDirEntries
Throws:
SVNClientException

getList

ISVNDirEntry[] getList(SVNUrl url,
                       SVNRevision revision,
                       SVNRevision pegRevision,
                       boolean recurse)
                       throws SVNClientException
List directory entries of a URL

Parameters:
url -
revision -
pegRevision -
recurse -
Returns:
an array of ISVNDirEntries
Throws:
SVNClientException

getListWithLocks

ISVNDirEntryWithLock[] getListWithLocks(SVNUrl url,
                                        SVNRevision revision,
                                        SVNRevision pegRevision,
                                        boolean recurse)
                                        throws SVNClientException
List directory entries of a URL with lock information

Parameters:
url -
revision -
pegRevision -
recurse -
Returns:
an array of ISVNDirEntries
Throws:
SVNClientException

getList

ISVNDirEntry[] getList(java.io.File path,
                       SVNRevision revision,
                       boolean recurse)
                       throws SVNClientException
List directory entries of a directory

Parameters:
path -
revision -
recurse -
Returns:
an array of ISVNDirEntries
Throws:
SVNClientException

getList

ISVNDirEntry[] getList(java.io.File path,
                       SVNRevision revision,
                       SVNRevision pegRevision,
                       boolean recurse)
                       throws SVNClientException
List directory entries of a directory

Parameters:
path -
revision -
pegRevision -
recurse -
Returns:
an array of ISVNDirEntries
Throws:
SVNClientException

getDirEntry

ISVNDirEntry getDirEntry(SVNUrl url,
                         SVNRevision revision)
                         throws SVNClientException
get the dirEntry for the given url

Parameters:
url -
revision -
Returns:
an ISVNDirEntry
Throws:
SVNClientException

getDirEntry

ISVNDirEntry getDirEntry(java.io.File path,
                         SVNRevision revision)
                         throws SVNClientException
get the dirEntry for the given directory

Parameters:
path -
revision -
Returns:
an ISVNDirEntry
Throws:
SVNClientException

getSingleStatus

ISVNStatus getSingleStatus(java.io.File path)
                           throws SVNClientException
Returns the status of a single file in the path.

Parameters:
path - File to gather status.
Returns:
a Status
Throws:
SVNClientException

getStatus

ISVNStatus[] getStatus(java.io.File[] path)
                       throws SVNClientException
Returns the status of given resources

Parameters:
path -
Returns:
the status of given resources
Throws:
SVNClientException

getStatus

ISVNStatus[] getStatus(java.io.File path,
                       boolean descend,
                       boolean getAll)
                       throws SVNClientException
Returns the status of path and its children. If descend is true, recurse fully, else do only immediate children. If getAll is set, retrieve all entries; otherwise, retrieve only "interesting" entries (local mods and/or out-of-date).

Parameters:
path - File to gather status.
descend - get recursive status information
getAll - get status information for all files
Returns:
a Status
Throws:
SVNClientException

getStatus

ISVNStatus[] getStatus(java.io.File path,
                       boolean descend,
                       boolean getAll,
                       boolean contactServer)
                       throws SVNClientException
Returns the status of path and its children. If descend is true, recurse fully, else do only immediate children. If getAll is set, retrieve all entries; otherwise, retrieve only "interesting" entries (local mods and/or out-of-date). Use the contactServer option to get server change information.

Parameters:
path - File to gather status.
descend - get recursive status information
getAll - get status information for all files
contactServer - contact server to get remote changes
Returns:
a Status
Throws:
SVNClientException

getStatus

ISVNStatus[] getStatus(java.io.File path,
                       boolean descend,
                       boolean getAll,
                       boolean contactServer,
                       boolean ignoreExternals)
                       throws SVNClientException
Returns the status of path and its children. If descend is true, recurse fully, else do only immediate children. If getAll is set, retrieve all entries; otherwise, retrieve only "interesting" entries (local mods and/or out-of-date). Use the contactServer option to get server change information.

Parameters:
path - File to gather status.
descend - get recursive status information
getAll - get status information for all files
contactServer - contact server to get remote changes
ignoreExternals - if externals are ignored during status
Returns:
a Status
Throws:
SVNClientException

copy

void copy(java.io.File srcPath,
          java.io.File destPath)
          throws SVNClientException
copy and schedule for addition (with history)

Parameters:
srcPath -
destPath -
Throws:
SVNClientException

copy

void copy(java.io.File srcPath,
          SVNUrl destUrl,
          java.lang.String message)
          throws SVNClientException
immediately commit a copy of WC to URL

Parameters:
srcPath -
destUrl -
message -
Throws:
SVNClientException

copy

void copy(java.io.File[] srcPaths,
          SVNUrl destUrl,
          java.lang.String message,
          boolean copyAsChild,
          boolean makeParents)
          throws SVNClientException
immediately commit a copy of WC to URL

Parameters:
srcPaths -
destUrl -
message -
copyAsChild -
makeParents -
Throws:
SVNClientException

copy

void copy(SVNUrl srcUrl,
          java.io.File destPath,
          SVNRevision revision)
          throws SVNClientException
check out URL into WC, schedule for addition

Parameters:
srcUrl -
destPath -
revision -
Throws:
SVNClientException

copy

void copy(SVNUrl srcUrl,
          java.io.File destPath,
          SVNRevision revision,
          boolean copyAsChild,
          boolean makeParents)
          throws SVNClientException
check out URL into WC, schedule for addition

Parameters:
srcUrl -
destPath -
revision -
boolean -
boolean -
Throws:
SVNClientException

copy

void copy(SVNUrl srcUrl,
          java.io.File destPath,
          SVNRevision revision,
          SVNRevision pegRevision,
          boolean copyAsChild,
          boolean makeParents)
          throws SVNClientException
check out URL into WC, schedule for addition

Parameters:
srcUrl -
destPath -
revision -
pegRevision -
boolean -
boolean -
Throws:
SVNClientException

copy

void copy(SVNUrl srcUrl,
          SVNUrl destUrl,
          java.lang.String message,
          SVNRevision revision)
          throws SVNClientException
complete server-side copy; used to branch & tag

Parameters:
srcUrl -
destUrl -
message -
revision -
Throws:
SVNClientException

copy

void copy(SVNUrl srcUrl,
          SVNUrl destUrl,
          java.lang.String message,
          SVNRevision revision,
          boolean makeParents)
          throws SVNClientException
complete server-side copy with option to create intermediate folders; used to branch & tag

Parameters:
srcUrl -
destUrl -
message -
revision -
make - parents
Throws:
SVNClientException

copy

void copy(SVNUrl[] srcUrls,
          SVNUrl destUrl,
          java.lang.String message,
          SVNRevision revision,
          boolean copyAsChild,
          boolean makeParents)
          throws SVNClientException
complete server-side copy with option to create intermediate folders; used to branch & tag

Parameters:
srcUrl -
destUrl -
message -
revision -
copyAsChild -
make - parents
Throws:
SVNClientException

remove

void remove(SVNUrl[] url,
            java.lang.String message)
            throws SVNClientException
item is deleted from the repository via an immediate commit.

Parameters:
url -
message -
Throws:
SVNClientException

remove

void remove(java.io.File[] file,
            boolean force)
            throws SVNClientException
the item is scheduled for deletion upon the next commit. Files, and directories that have not been committed, are immediately removed from the working copy. The command will not remove TARGETs that are, or contain, unversioned or modified items; use the force option to override this behaviour.

Parameters:
file -
force -
Throws:
SVNClientException

doExport

void doExport(SVNUrl srcUrl,
              java.io.File destPath,
              SVNRevision revision,
              boolean force)
              throws SVNClientException
Exports a clean directory tree from the repository specified by srcUrl, at revision revision

Parameters:
srcUrl -
destPath -
revision -
force -
Throws:
SVNClientException

doExport

void doExport(java.io.File srcPath,
              java.io.File destPath,
              boolean force)
              throws SVNClientException
Exports a clean directory tree from the working copy specified by PATH1 into PATH2. all local changes will be preserved, but files not under revision control will not be copied.

Parameters:
srcPath -
destPath -
force -
Throws:
SVNClientException

doImport

void doImport(java.io.File path,
              SVNUrl url,
              java.lang.String message,
              boolean recurse)
              throws SVNClientException
Import file or directory PATH into repository directory URL at head

Parameters:
path -
url -
message -
recurse -
Throws:
SVNClientException

mkdir

void mkdir(SVNUrl url,
           java.lang.String message)
           throws SVNClientException
Creates a directory directly in a repository

Parameters:
url -
message -
Throws:
SVNClientException

mkdir

void mkdir(SVNUrl url,
           boolean makeParents,
           java.lang.String message)
           throws SVNClientException
Creates a directory directly in a repository

Parameters:
url -
makeParents -
message -
Throws:
SVNClientException

mkdir

void mkdir(java.io.File file)
           throws SVNClientException
creates a directory on disk and schedules it for addition.

Parameters:
file -
Throws:
SVNClientException

move

void move(java.io.File srcPath,
          java.io.File destPath,
          boolean force)
          throws SVNClientException
Moves or renames a file.

Parameters:
srcPath -
destPath -
force -
Throws:
SVNClientException

move

void move(SVNUrl srcUrl,
          SVNUrl destUrl,
          java.lang.String message,
          SVNRevision revision)
          throws SVNClientException
Moves or renames a file.

Parameters:
srcUrl -
destUrl -
message -
revision -
Throws:
SVNClientException

update

long update(java.io.File path,
            SVNRevision revision,
            boolean recurse)
            throws SVNClientException
Update a file or a directory

Parameters:
path -
revision -
recurse -
Returns:
Returns a long representing the revision. It returns a -1 if the revision number is invalid.
Throws:
SVNClientException

update

long update(java.io.File path,
            SVNRevision revision,
            int depth,
            boolean setDepth,
            boolean ignoreExternals,
            boolean force)
            throws SVNClientException
Update a file or a directory

Parameters:
path -
revision -
depth -
setDepth -
ignoreExternals -
force -
Returns:
Returns a long representing the revision. It returns a -1 if the revision number is invalid.
Throws:
SVNClientException

update

long[] update(java.io.File[] path,
              SVNRevision revision,
              boolean recurse,
              boolean ignoreExternals)
              throws SVNClientException
Updates the directories or files from repository

Parameters:
path - array of target files.
revision - the revision number to update.
recurse - recursively update.
ignoreExternals - if externals are ignored during update
Returns:
Returns an array of longs representing the revision. It returns a -1 if the revision number is invalid.
Throws:
SVNClientException
Since:
1.2

update

long[] update(java.io.File[] path,
              SVNRevision revision,
              int depth,
              boolean setDepth,
              boolean ignoreExternals,
              boolean force)
              throws SVNClientException
Updates the directories or files from repository

Parameters:
path - array of target files.
revision - the revision number to update.
depth - the depth to recursively update.
setDepth - change working copy to specified depth
ignoreExternals - if externals are ignored during update.
force - allow unversioned paths that obstruct adds.
Returns:
Returns an array of longs representing the revision. It returns a -1 if the revision number is invalid.
Throws:
SVNClientException

revert

void revert(java.io.File path,
            boolean recurse)
            throws SVNClientException
Restore pristine working copy file (undo all local edits)

Parameters:
path -
recurse -
Throws:
SVNClientException

getLogMessages

ISVNLogMessage[] getLogMessages(SVNUrl url,
                                SVNRevision revisionStart,
                                SVNRevision revisionEnd)
                                throws SVNClientException
Get the log messages for a set of revision(s)

Parameters:
url -
revisionStart -
revisionEnd -
Returns:
The list of log messages.
Throws:
SVNClientException

getLogMessages

ISVNLogMessage[] getLogMessages(SVNUrl url,
                                SVNRevision revisionStart,
                                SVNRevision revisionEnd,
                                boolean fetchChangePath)
                                throws SVNClientException
Get the log messages for a set of revision(s)

Parameters:
url -
revisionStart -
revisionEnd -
fetchChangePath - Whether or not to interogate the repository for the verbose log information containing the list of paths touched by the delta specified by revisionStart and revisionEnd. Setting this to false results in a more performant and memory efficient operation.
Returns:
The list of log messages.
Throws:
SVNClientException

getLogMessages

ISVNLogMessage[] getLogMessages(SVNUrl url,
                                java.lang.String[] paths,
                                SVNRevision revStart,
                                SVNRevision revEnd,
                                boolean stopOnCopy,
                                boolean fetchChangePath)
                                throws SVNClientException
Get the log messages for a set paths and revision(s)

Parameters:
url -
paths -
revStart -
revEnd -
stopOnCopy -
fetchChangePath -
Returns:
The list of log messages.
Throws:
SVNClientException

getLogMessages

ISVNLogMessage[] getLogMessages(java.io.File path,
                                SVNRevision revisionStart,
                                SVNRevision revisionEnd)
                                throws SVNClientException
Get the log messages for a set of revision(s)

Parameters:
path -
revisionStart -
revisionEnd -
Returns:
The list of log messages.
Throws:
SVNClientException

getLogMessages

ISVNLogMessage[] getLogMessages(java.io.File path,
                                SVNRevision revisionStart,
                                SVNRevision revisionEnd,
                                boolean fetchChangePath)
                                throws SVNClientException
Get the log messages for a set of revision(s)

Parameters:
path -
revisionStart -
revisionEnd -
fetchChangePath - Whether or not to interogate the repository for the verbose log information containing the list of paths touched by the delta specified by revisionStart and revisionEnd. Setting this to false results in a more performant and memory efficient operation.
Returns:
The list of log messages.
Throws:
SVNClientException

getLogMessages

ISVNLogMessage[] getLogMessages(java.io.File path,
                                SVNRevision revisionStart,
                                SVNRevision revisionEnd,
                                boolean stopOnCopy,
                                boolean fetchChangePath)
                                throws SVNClientException
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
fetchChangePath - returns the paths of the changed items in the returned objects
Returns:
array of LogMessages
Throws:
SVNClientException

getLogMessages

ISVNLogMessage[] getLogMessages(java.io.File path,
                                SVNRevision revisionStart,
                                SVNRevision revisionEnd,
                                boolean stopOnCopy,
                                boolean fetchChangePath,
                                long limit)
                                throws SVNClientException
Retrieve the log messages for an item

Parameters:
path - path to get the log message for.
revisionStart - first revision to show
revisionEnd - last revision to show
stopOnCopy - do not continue on copy operations
fetchChangePath - 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:
SVNClientException

getLogMessages

ISVNLogMessage[] getLogMessages(java.io.File path,
                                SVNRevision pegRevision,
                                SVNRevision revisionStart,
                                SVNRevision revisionEnd,
                                boolean stopOnCopy,
                                boolean fetchChangePath,
                                long limit,
                                boolean includeMergedRevisions)
                                throws SVNClientException
Retrieve the log messages for an item

Parameters:
path - path to get the log message for.
pegRevision - peg revision for URL
revisionStart - first revision to show
revisionEnd - last revision to show
stopOnCopy - do not continue on copy operations
fetchChangePath - returns the paths of the changed items in the returned objects
limit - limit the number of log messages (if 0 or less no limit)
includeMergedRevisions - include revisions that were merged
Returns:
array of LogMessages
Throws:
SVNClientException

getLogMessages

ISVNLogMessage[] getLogMessages(SVNUrl url,
                                SVNRevision pegRevision,
                                SVNRevision revisionStart,
                                SVNRevision revisionEnd,
                                boolean stopOnCopy,
                                boolean fetchChangePath,
                                long limit)
                                throws SVNClientException
Retrieve the log messages for an item

Parameters:
url - url to get the log message for.
pegRevision - peg revision for URL
revisionStart - first revision to show
revisionEnd - last revision to show
stopOnCopy - do not continue on copy operations
fetchChangePath - 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:
SVNClientException

getLogMessages

ISVNLogMessage[] getLogMessages(SVNUrl url,
                                SVNRevision pegRevision,
                                SVNRevision revisionStart,
                                SVNRevision revisionEnd,
                                boolean stopOnCopy,
                                boolean fetchChangePath,
                                long limit,
                                boolean includeMergedRevisions)
                                throws SVNClientException
Retrieve the log messages for an item

Parameters:
url - url to get the log message for.
pegRevision - peg revision for URL
revisionStart - first revision to show
revisionEnd - last revision to show
stopOnCopy - do not continue on copy operations
fetchChangePath - returns the paths of the changed items in the returned objects
limit - limit the number of log messages (if 0 or less no limit)
includeMergedRevisions - include revisions that were merged
Returns:
array of LogMessages
Throws:
SVNClientException

getLogMessages

void getLogMessages(java.io.File path,
                    SVNRevision pegRevision,
                    SVNRevision revisionStart,
                    SVNRevision revisionEnd,
                    boolean stopOnCopy,
                    boolean fetchChangePath,
                    long limit,
                    boolean includeMergedRevisions,
                    java.lang.String[] requestedProperties,
                    ISVNLogMessageCallback callback)
                    throws SVNClientException
Retrieve the log messages for an item

Parameters:
path - path to get the log message for.
pegRevision - peg revision for URL
revisionStart - first revision to show
revisionEnd - last revision to show
stopOnCopy - do not continue on copy operations
fetchChangePath - returns the paths of the changed items in the returned objects
limit - limit the number of log messages (if 0 or less no limit)
includeMergedRevisions - include revisions that were merged
requestedProperties - the revision properties to return for each entry
callback - callback class to receive log messages
Throws:
SVNClientException

getLogMessages

void getLogMessages(SVNUrl url,
                    SVNRevision pegRevision,
                    SVNRevision revisionStart,
                    SVNRevision revisionEnd,
                    boolean stopOnCopy,
                    boolean fetchChangePath,
                    long limit,
                    boolean includeMergedRevisions,
                    java.lang.String[] requestedProperties,
                    ISVNLogMessageCallback callback)
                    throws SVNClientException
Retrieve the log messages for an item

Parameters:
url - url to get the log message for.
pegRevision - peg revision for URL
revisionStart - first revision to show
revisionEnd - last revision to show
stopOnCopy - do not continue on copy operations
fetchChangePath - returns the paths of the changed items in the returned objects
limit - limit the number of log messages (if 0 or less no limit)
includeMergedRevisions - include revisions that were merged
requestedProperties - the revision properties to return for each entry
callback - callback class to receive log messages
Throws:
SVNClientException

getContent

java.io.InputStream getContent(SVNUrl url,
                               SVNRevision revision,
                               SVNRevision pegRevision)
                               throws SVNClientException
get the content of a file

Parameters:
url -
revision -
peg - revision
Returns:
the input stream with a content of the file
Throws:
SVNClientException

getContent

java.io.InputStream getContent(SVNUrl url,
                               SVNRevision revision)
                               throws SVNClientException
get the content of a file

Parameters:
url -
revision -
Returns:
the input stream with a content of the file
Throws:
SVNClientException

getContent

java.io.InputStream getContent(java.io.File path,
                               SVNRevision revision)
                               throws SVNClientException
get the content of a file

Parameters:
path -
revision -
Returns:
the input stream with a content of the file
Throws:
SVNClientException

propertySet

void propertySet(java.io.File path,
                 java.lang.String propertyName,
                 java.lang.String propertyValue,
                 boolean recurse)
                 throws SVNClientException
set a property

Parameters:
path -
propertyName -
propertyValue -
recurse -
Throws:
SVNClientException

propertySet

void propertySet(java.io.File path,
                 java.lang.String propertyName,
                 java.io.File propertyFile,
                 boolean recurse)
                 throws SVNClientException,
                        java.io.IOException
set a property using the content of a file

Parameters:
path -
propertyName -
propertyFile -
recurse -
Throws:
SVNClientException
java.io.IOException

propertyGet

ISVNProperty propertyGet(java.io.File path,
                         java.lang.String propertyName)
                         throws SVNClientException
get a property or null if property is not found

Parameters:
path -
propertyName -
Returns:
a property or null
Throws:
SVNClientException

propertyGet

ISVNProperty propertyGet(SVNUrl url,
                         java.lang.String propertyName)
                         throws SVNClientException
get a property or null if property is not found

Parameters:
url -
propertyName -
Returns:
a property or null
Throws:
SVNClientException

propertyGet

ISVNProperty propertyGet(SVNUrl url,
                         SVNRevision revision,
                         SVNRevision peg,
                         java.lang.String propertyName)
                         throws SVNClientException
get a property or null if property is not found

Parameters:
url -
revision -
peg -
propertyName -
Returns:
a property or null
Throws:
SVNClientException

propertyDel

void propertyDel(java.io.File path,
                 java.lang.String propertyName,
                 boolean recurse)
                 throws SVNClientException
delete a property

Parameters:
path -
propertyName -
recurse -
Throws:
SVNClientException

setRevProperty

void setRevProperty(SVNUrl path,
                    SVNRevision.Number revisionNo,
                    java.lang.String propName,
                    java.lang.String propertyData,
                    boolean force)
                    throws SVNClientException
set the revision property for a given revision

Parameters:
path -
revisionNo -
propName -
propertyData -
force -
Throws:
SVNClientException

getRevProperty

java.lang.String getRevProperty(SVNUrl path,
                                SVNRevision.Number revisionNo,
                                java.lang.String propName)
                                throws SVNClientException
get a revision property for a given revision

Parameters:
path -
revisionNo -
propName -
Throws:
SVNClientException

getIgnoredPatterns

java.util.List getIgnoredPatterns(java.io.File path)
                                  throws SVNClientException
get the ignored patterns for the given directory if path is not a directory, returns null

Parameters:
path -
Returns:
list of ignored patterns
Throws:
SVNClientException

addToIgnoredPatterns

void addToIgnoredPatterns(java.io.File path,
                          java.lang.String pattern)
                          throws SVNClientException
add a pattern to svn:ignore property

Parameters:
path -
pattern -
Throws:
SVNClientException

setIgnoredPatterns

void setIgnoredPatterns(java.io.File path,
                        java.util.List patterns)
                        throws SVNClientException
set the ignored patterns for the given directory

Parameters:
path -
patterns -
Throws:
SVNClientException

diff

void diff(java.io.File oldPath,
          SVNRevision oldPathRevision,
          java.io.File newPath,
          SVNRevision newPathRevision,
          java.io.File outFile,
          boolean recurse)
          throws SVNClientException
display the differences between two paths.

Parameters:
oldPath -
oldPathRevision -
newPath -
newPathRevision -
outFile -
recurse -
Throws:
SVNClientException

diff

void diff(java.io.File oldPath,
          SVNRevision oldPathRevision,
          java.io.File newPath,
          SVNRevision newPathRevision,
          java.io.File outFile,
          boolean recurse,
          boolean ignoreAncestry,
          boolean noDiffDeleted,
          boolean force)
          throws SVNClientException
display the differences between two paths.

Parameters:
oldPath -
oldPathRevision -
newPath -
newPathRevision -
outFile -
recurse -
ignoreAncestry -
noDiffDeleted -
force -
Throws:
SVNClientException

diff

void diff(java.io.File path,
          java.io.File outFile,
          boolean recurse)
          throws SVNClientException
display the differences between two paths.

Parameters:
path -
outFile -
recurse -
Throws:
SVNClientException

diff

void diff(java.io.File[] paths,
          java.io.File outFile,
          boolean recurse)
          throws SVNClientException
display the combined differences for an array of paths.

Parameters:
paths -
outFile -
recurse -
Throws:
SVNClientException

createPatch

void createPatch(java.io.File[] paths,
                 java.io.File relativeToPath,
                 java.io.File outFile,
                 boolean recurse)
                 throws SVNClientException
create a patch from local differences.

Parameters:
paths -
relativeToPath - - create patch relative to this location
outFile -
recurse -
Throws:
SVNClientException

diff

void diff(SVNUrl oldUrl,
          SVNRevision oldUrlRevision,
          SVNUrl newUrl,
          SVNRevision newUrlRevision,
          java.io.File outFile,
          boolean recurse)
          throws SVNClientException
display the differences between two urls.

Parameters:
oldUrl -
oldUrlRevision -
newUrl -
newUrlRevision -
outFile -
recurse -
Throws:
SVNClientException

diff

void diff(SVNUrl oldUrl,
          SVNRevision oldUrlRevision,
          SVNUrl newUrl,
          SVNRevision newUrlRevision,
          java.io.File outFile,
          boolean recurse,
          boolean ignoreAncestry,
          boolean noDiffDeleted,
          boolean force)
          throws SVNClientException
display the differences between two urls.

Parameters:
oldUrl -
oldUrlRevision -
newUrl -
newUrlRevision -
outFile -
recurse -
ignoreAncestry -
noDiffDeleted -
force -
Throws:
SVNClientException

diff

void diff(SVNUrl target,
          SVNRevision pegRevision,
          SVNRevision startRevision,
          SVNRevision endRevision,
          java.io.File outFile,
          int depth,
          boolean ignoreAncestry,
          boolean noDiffDeleted,
          boolean force)
          throws SVNClientException
Display the differences between two paths.

Parameters:
target -
pegRevision -
startRevision -
endRevision -
outFile -
depth -
ignoreAncestry -
noDiffDeleted -
force -
Throws:
SVNClientException

diff

void diff(SVNUrl target,
          SVNRevision pegRevision,
          SVNRevision startRevision,
          SVNRevision endRevision,
          java.io.File outFile,
          boolean recurse)
          throws SVNClientException
Display the differences between two paths.

Parameters:
target -
pegRevision -
startRevision -
endRevision -
outFile -
recurse -
Throws:
SVNClientException

diff

void diff(SVNUrl url,
          SVNRevision oldUrlRevision,
          SVNRevision newUrlRevision,
          java.io.File outFile,
          boolean recurse)
          throws SVNClientException
display the differences between two urls.

Parameters:
url -
oldUrlRevision -
newUrlRevision -
outFile -
recurse -
Throws:
SVNClientException

diff

void diff(java.io.File path,
          SVNUrl url,
          SVNRevision urlRevision,
          java.io.File outFile,
          boolean recurse)
          throws SVNClientException
display the differences between WC and url.

Parameters:
path -
url -
urlRevision -
outFile -
recurse -
Throws:
SVNClientException

getKeywords

SVNKeywords getKeywords(java.io.File path)
                        throws SVNClientException
returns the keywords used for substitution for the given resource

Parameters:
path -
Returns:
the keywords used for substitution
Throws:
SVNClientException

setKeywords

void setKeywords(java.io.File path,
                 SVNKeywords keywords,
                 boolean recurse)
                 throws SVNClientException
set the keywords substitution for the given resource

Parameters:
path -
keywords -
recurse -
Throws:
SVNClientException

addKeywords

SVNKeywords addKeywords(java.io.File path,
                        SVNKeywords keywords)
                        throws SVNClientException
add some keyword to the keywords substitution list

Parameters:
path -
keywords -
Returns:
keywords valid after this method call
Throws:
SVNClientException

removeKeywords

SVNKeywords removeKeywords(java.io.File path,
                           SVNKeywords keywords)
                           throws SVNClientException
remove some keywords to the keywords substitution list

Parameters:
path -
keywords -
Returns:
keywords valid after this method call
Throws:
SVNClientException

annotate

ISVNAnnotations annotate(SVNUrl url,
                         SVNRevision revisionStart,
                         SVNRevision revisionEnd)
                         throws SVNClientException
Output the content of specified url with revision and author information in-line.

Parameters:
url -
revisionStart -
revisionEnd -
Returns:
annotations for the given url
Throws:
SVNClientException

annotate

ISVNAnnotations annotate(java.io.File file,
                         SVNRevision revisionStart,
                         SVNRevision revisionEnd)
                         throws SVNClientException
Output the content of specified file with revision and author information in-line.

Parameters:
file -
revisionStart -
revisionEnd -
Returns:
annotations for the given file
Throws:
SVNClientException

annotate

ISVNAnnotations annotate(SVNUrl url,
                         SVNRevision revisionStart,
                         SVNRevision revisionEnd,
                         SVNRevision pegRevision,
                         boolean ignoreMimeType,
                         boolean includeMergedRevisions)
                         throws SVNClientException
Output the content of specified url with revision and author information in-line.

Parameters:
url -
revisionStart -
revisionEnd -
pegRevision -
ignoreMimeType -
includeMergedRevisons -
Returns:
annotations for the given url
Throws:
SVNClientException

annotate

ISVNAnnotations annotate(java.io.File file,
                         SVNRevision revisionStart,
                         SVNRevision revisionEnd,
                         boolean ignoreMimeType,
                         boolean includeMergedRevisions)
                         throws SVNClientException
Output the content of specified file with revision and author information in-line.

Parameters:
file -
revisionStart -
revisionEnd -
ignoreMimeType -
includeMergedRevisons -
Returns:
annotations for the given file
Throws:
SVNClientException

annotate

ISVNAnnotations annotate(java.io.File file,
                         SVNRevision revisionStart,
                         SVNRevision revisionEnd,
                         SVNRevision pegRevision,
                         boolean ignoreMimeType,
                         boolean includeMergedRevisions)
                         throws SVNClientException
Output the content of specified file with revision and author information in-line.

Parameters:
file -
revisionStart -
revisionEnd -
pegRevision; -
ignoreMimeType -
includeMergedRevisons -
Returns:
annotations for the given file
Throws:
SVNClientException

getProperties

ISVNProperty[] getProperties(java.io.File path)
                             throws SVNClientException
Get all the properties for the given file or dir

Parameters:
path -
Returns:
the properties for the given url
Throws:
SVNClientException

getProperties

ISVNProperty[] getProperties(SVNUrl url,
                             SVNRevision revision,
                             SVNRevision peg)
                             throws SVNClientException
Get all the properties for the given url

Parameters:
url -
revision -
peg -
Returns:
information about an URL.
Throws:
SVNClientException

getProperties

ISVNProperty[] getProperties(SVNUrl url)
                             throws SVNClientException
Get all the properties for the given url

Parameters:
url -
Returns:
the properties for the given url
Throws:
SVNClientException

getRevProperties

ISVNProperty[] getRevProperties(SVNUrl url,
                                SVNRevision.Number revision)
                                throws SVNClientException
Get all the revision properties for the given url at a revision

Parameters:
url -
revision -
Returns:
information about an URL.
Throws:
SVNClientException

resolved

void resolved(java.io.File path)
              throws SVNClientException
Remove 'conflicted' state on working copy files or directories

Parameters:
path -
Throws:
SVNClientException

resolve

void resolve(java.io.File path,
             int result)
             throws SVNClientException
Remove 'conflicted' state on working copy files or directories

Parameters:
path -
result - - choose resolve option - ISVNConflictResolver.Choice
Throws:
SVNClientException

createRepository

void createRepository(java.io.File path,
                      java.lang.String repositoryType)
                      throws SVNClientException
Create a new, empty repository at path

Parameters:
path -
repositoryType - either REPOSITORY_FSTYPE_BDB or REPOSITORY_FSTYPE_FSFS or null (will use svnadmin default)
Throws:
SVNClientException

cancelOperation

void cancelOperation()
                     throws SVNClientException
Cancel the current operation

Throws:
SVNClientException

getInfoFromWorkingCopy

ISVNInfo getInfoFromWorkingCopy(java.io.File file)
                                throws SVNClientException
Get information about a file or directory from working copy. Uses info() call which does NOT contact the repository

Parameters:
file -
Returns:
information about a file or directory from working copy.
Throws:
SVNClientException

getInfo

ISVNInfo getInfo(java.io.File file)
                 throws SVNClientException
Get information about a file or directory. Uses info2() call which contacts the repository

Parameters:
file -
Returns:
information about a file or directory.
Throws:
SVNClientException

getInfo

ISVNInfo[] getInfo(java.io.File file,
                   boolean descend)
                   throws SVNClientException
Get information about a file or directory. Uses info2() call which contacts the repository

Parameters:
file -
descend - get recursive information
Returns:
information about a file or directory.
Throws:
SVNClientException

getInfo

ISVNInfo getInfo(SVNUrl url)
                 throws SVNClientException
Get information about an URL. Uses info2() call which contacts the repository

Parameters:
url -
Returns:
information about an URL.
Throws:
SVNClientException

getInfo

ISVNInfo getInfo(SVNUrl url,
                 SVNRevision revision,
                 SVNRevision peg)
                 throws SVNClientException
Get information about an URL. Uses info2() call which contacts the repository

Parameters:
url -
revision -
peg -
Returns:
information about an URL.
Throws:
SVNClientException

switchToUrl

void switchToUrl(java.io.File path,
                 SVNUrl url,
                 SVNRevision revision,
                 boolean recurse)
                 throws SVNClientException
Update the working copy to mirror a new URL within the repository. This behaviour is similar to 'svn update', and is the way to move a working copy to a branch or tag within the same repository.

Parameters:
url -
path -
revision -
recurse -
Throws:
SVNClientException

switchToUrl

void switchToUrl(java.io.File path,
                 SVNUrl url,
                 SVNRevision revision,
                 int depth,
                 boolean setDepth,
                 boolean ignoreExternals,
                 boolean force)
                 throws SVNClientException
Update the working copy to mirror a new URL within the repository. This behaviour is similar to 'svn update', and is the way to move a working copy to a branch or tag within the same repository.

Parameters:
url -
path -
revision -
depth -
setDepth -
ignoreExternals -
force -
Throws:
SVNClientException

switchToUrl

void switchToUrl(java.io.File path,
                 SVNUrl url,
                 SVNRevision revision,
                 SVNRevision pegRevision,
                 int depth,
                 boolean setDepth,
                 boolean ignoreExternals,
                 boolean force)
                 throws SVNClientException
Update the working copy to mirror a new URL within the repository. This behaviour is similar to 'svn update', and is the way to move a working copy to a branch or tag within the same repository.

Parameters:
url -
path -
revision -
pegRevision -
depth -
setDepth -
ignoreExternals -
force -
Throws:
SVNClientException

setConfigDirectory

void setConfigDirectory(java.io.File dir)
                        throws SVNClientException
Set the configuration directory.

Parameters:
dir -
Throws:
SVNClientException

cleanup

void cleanup(java.io.File dir)
             throws SVNClientException
Perform a clanup on the working copy. This will remove any stale transactions

Parameters:
dir -
Throws:
SVNClientException

merge

void merge(SVNUrl path1,
           SVNRevision revision1,
           SVNUrl path2,
           SVNRevision revision2,
           java.io.File localPath,
           boolean force,
           boolean recurse)
           throws SVNClientException
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:
SVNClientException

merge

void merge(SVNUrl path1,
           SVNRevision revision1,
           SVNUrl path2,
           SVNRevision revision2,
           java.io.File localPath,
           boolean force,
           boolean recurse,
           boolean dryRun)
           throws SVNClientException
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
dryRun - do not update working copy
Throws:
SVNClientException

merge

void merge(SVNUrl path1,
           SVNRevision revision1,
           SVNUrl path2,
           SVNRevision revision2,
           java.io.File localPath,
           boolean force,
           boolean recurse,
           boolean dryRun,
           boolean ignoreAncestry)
           throws SVNClientException
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
dryRun - do not update working copy
ignoreAncestry - ignore ancestry when calculating merges
Throws:
SVNClientException

merge

void merge(SVNUrl path1,
           SVNRevision revision1,
           SVNUrl path2,
           SVNRevision revision2,
           java.io.File localPath,
           boolean force,
           int depth,
           boolean dryRun,
           boolean ignoreAncestry,
           boolean recordOnly)
           throws SVNClientException
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
int - depth
dryRun - do not update working copy
ignoreAncestry - ignore ancestry when calculating merges
recordOnly - just records mergeinfo, does not perform merge
Throws:
SVNClientException

mergeReintegrate

void mergeReintegrate(SVNUrl path,
                      SVNRevision pegRevision,
                      java.io.File localPath,
                      boolean force,
                      boolean dryRun)
                      throws SVNClientException
Perform 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 url
pegRevision - revision to interpret path
localPath - target local path
force - THIS IS NOT CURRENTLY USED
dryRun - do not update working copy
Throws:
SVNClientException

lock

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

Parameters:
paths - path of the items to lock
comment -
force - break an existing lock
Throws:
SVNClientException

unlock

void unlock(SVNUrl[] paths,
            boolean force)
            throws SVNClientException
Unlock a working copy item

Parameters:
paths - path of the items to unlock
force - break an existing lock
Throws:
SVNClientException

lock

void lock(java.io.File[] paths,
          java.lang.String comment,
          boolean force)
          throws SVNClientException
Lock a working copy item

Parameters:
paths - path of the items to lock
comment -
force - break an existing lock
Throws:
SVNClientException

unlock

void unlock(java.io.File[] paths,
            boolean force)
            throws SVNClientException
Unlock a working copy item

Parameters:
paths - path of the items to unlock
force - break an existing lock
Throws:
SVNClientException

statusReturnsRemoteInfo

boolean statusReturnsRemoteInfo()
Indicates whether a status call that contacts the server includes the remote info in the status object

Returns:
true when the client adapter implementation delivers remote info within status

canCommitAcrossWC

boolean canCommitAcrossWC()
Indicates whether the commitAcrossWC method is supported in the adapter

Returns:
true when the client adapter implementation supports commitAcrossWC

getAdminDirectoryName

java.lang.String getAdminDirectoryName()
Returns the name of the Subversion administrative working copy directory. Typically will be ".svn".

Returns:
the name of the Subversion administrative wc dir

isAdminDirectory

boolean isAdminDirectory(java.lang.String name)
Returns whether the passed folder name is a Subversion administrative working copy directory. Will always return true if ".svn" is passed. Otherwise, will be based on the Subversion runtime

Parameters:
name -
Returns:
true whether the folder is a Subversion administrative dir

relocate

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

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

merge

void merge(SVNUrl url,
           SVNRevision pegRevision,
           SVNRevisionRange[] revisions,
           java.io.File localPath,
           boolean force,
           int depth,
           boolean ignoreAncestry,
           boolean dryRun,
           boolean recordOnly)
           throws SVNClientException
Merge set of revisions into a new local path.

Parameters:
url - url
pegRevision - revision to interpret path
revisions - revisions to merge (must be in the form N-1:M)
localPath - target local path
force - overwrite local changes
depth - how deep to traverse into subdirectories
ignoreAncestry - ignore if files are not related
dryRun - do not change anything
recordOnly - just records mergeinfo, does not perform merge
Throws:
SVNClientException

getMergeInfo

ISVNMergeInfo getMergeInfo(java.io.File path,
                           SVNRevision revision)
                           throws SVNClientException
Get merge info for path at revision.

Parameters:
path - Local Path.
revision - SVNRevision at which to get the merge info for path.
Throws:
SVNClientException

getMergeInfo

ISVNMergeInfo getMergeInfo(SVNUrl url,
                           SVNRevision revision)
                           throws SVNClientException
Get merge info for url at revision.

Parameters:
url - URL.
revision - SVNRevision at which to get the merge info for path.
Throws:
SVNClientException

getMergeinfoLog

ISVNLogMessage[] getMergeinfoLog(int kind,
                                 java.io.File path,
                                 SVNRevision pegRevision,
                                 SVNUrl mergeSourceUrl,
                                 SVNRevision srcPegRevision,
                                 boolean discoverChangedPaths)
                                 throws SVNClientException
Retrieve either merged or eligible-to-be-merged revisions.

Parameters:
kind - kind of revisions to receive
path - target of merge
pegRevision - peg rev for path
mergeSourceUrl - the source of the merge
srcPegRevision - peg rev for mergeSourceUrl
discoverChangedPaths - return paths of changed items
Returns:
array of log messages
Throws:
SVNClientException

getMergeinfoLog

ISVNLogMessage[] getMergeinfoLog(int kind,
                                 SVNUrl url,
                                 SVNRevision pegRevision,
                                 SVNUrl mergeSourceUrl,
                                 SVNRevision srcPegRevision,
                                 boolean discoverChangedPaths)
                                 throws SVNClientException
Retrieve either merged or eligible-to-be-merged revisions.

Parameters:
kind - kind of revisions to receive
url - target of merge
pegRevision - peg rev for path
mergeSourceUrl - the source of the merge
srcPegRevision - peg rev for mergeSourceUrl
discoverChangedPaths - return paths of changed items
Returns:
array of log messages
Throws:
SVNClientException

diffSummarize

SVNDiffSummary[] diffSummarize(SVNUrl target1,
                               SVNRevision revision1,
                               SVNUrl target2,
                               SVNRevision revision2,
                               int depth,
                               boolean ignoreAncestry)
                               throws SVNClientException
Produce a diff summary which lists the items changed between path and revision pairs.

Parameters:
target1 - URL.
revision1 - Revision of target1.
target2 - URL.
revision2 - Revision of target2.
depth - how deep to recurse.
ignoreAncestry - Whether to ignore unrelated files during comparison. False positives may potentially be reported if this parameter false, since a file might have been modified between two revisions, but still have the same contents.
Returns:
the list of differences
Throws:
SVNClientException

diffSummarize

SVNDiffSummary[] diffSummarize(SVNUrl target,
                               SVNRevision pegRevision,
                               SVNRevision startRevision,
                               SVNRevision endRevision,
                               int depth,
                               boolean ignoreAncestry)
                               throws SVNClientException
Produce a diff summary which lists the items changed between path and revision pairs.

Parameters:
target - URL.
pegRevision - Revision at which to interpret target. If RevisionKind#unspecified or null, behave identically to diffSummarize(String, Revision, String, Revision, boolean, boolean, DiffSummaryReceiver), using path for both of that method's targets.
startRevision - Beginning of range for comparsion of target.
endRevision - End of range for comparsion of target.
depth - how deep to recurse.
ignoreAncestry - Whether to ignore unrelated files during comparison. False positives may potentially be reported if this parameter false, since a file might have been modified between two revisions, but still have the same contents.
Returns:
the list of differences
Throws:
SVNClientException

diffSummarize

SVNDiffSummary[] diffSummarize(java.io.File path,
                               SVNUrl toUrl,
                               SVNRevision toRevision,
                               boolean recurse)
                               throws SVNClientException
Throws:
SVNClientException

suggestMergeSources

java.lang.String[] suggestMergeSources(java.io.File path)
                                       throws SVNClientException
Return an ordered list of suggested merge source URLs.

Parameters:
path - The merge target path for which to suggest sources.
Returns:
The list of URLs, empty if there are no suggestions.
Throws:
SVNClientException - If an error occurs.

suggestMergeSources

java.lang.String[] suggestMergeSources(SVNUrl url,
                                       SVNRevision peg)
                                       throws SVNClientException
Return an ordered list of suggested merge source URLs.

Parameters:
url - The merge target path for which to suggest sources.
peg - The peg revision for the URL
Returns:
The list of URLs, empty if there are no suggestions.
Throws:
SVNClientException - If an error occurs.

dispose

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