| java.lang.Object
 org.tmatesoft.svn.core.wc.SVNBasicClient
org.tmatesoft.svn.core.wc.SVNCommitClient
| SVNCommitClient | | public class SVNCommitClient extends SVNBasicClient (Code) | | The SVNCommitClient class provides methods to perform operations that relate to
committing changes to an SVN repository. These operations are similar to
respective commands of the native SVN command line client
and include ones which operate on working copy items as well as ones
that operate only on a repository.
Here's a list of the SVNCommitClient's commit-related methods
matched against corresponing commands of the SVN command line
client:
| SVNKit |
Subversion |
| doCommit() | 'svn commit' |
| doImport() | 'svn import' |
| doDelete() | 'svn delete URL' |
| doMkDir() | 'svn mkdir URL' |
version:
1.1.1
author:
TMate Software Ltd.
See Also: Examples |
| Method Summary | |
| public SVNCommitPacket | doCollectCommitItems(File[] paths, boolean keepLocks, boolean force, boolean recursive)
Collects commit items (containing detailed information on each Working Copy item
that was changed and need to be committed to the repository) into a single
SVNCommitPacket. | | public SVNCommitPacket[] | doCollectCommitItems(File[] paths, boolean keepLocks, boolean force, boolean recursive, boolean combinePackets)
Collects commit items (containing detailed information on each Working Copy item
that was changed and need to be committed to the repository) into different
SVNCommitPackets. | | public SVNCommitInfo | doCommit(File[] paths, boolean keepLocks, String commitMessage, boolean force, boolean recursive)
Committs local changes made to the Working Copy items (provided as an array of
java.io.File s) to the repository. | | public SVNCommitInfo | doCommit(SVNCommitPacket commitPacket, boolean keepLocks, String commitMessage)
Committs local changes made to the Working Copy items to the repository. | | public SVNCommitInfo[] | doCommit(SVNCommitPacket[] commitPackets, boolean keepLocks, String commitMessage)
Committs local changes, made to the Working Copy items, to the repository. | | public SVNCommitInfo | doDelete(SVNURL[] urls, String commitMessage)
Committs removing specified URL-paths from the repository. | | public SVNCommitInfo | doImport(File path, SVNURL dstURL, String commitMessage, boolean recursive)
Committs an addition of a local unversioned file or directory into
the repository. | | public SVNCommitInfo | doImport(File path, SVNURL dstURL, String commitMessage, boolean useGlobalIgnores, boolean recursive)
Committs an addition of a local unversioned file or directory into
the repository. | | public SVNCommitInfo | doMkDir(SVNURL[] urls, String commitMessage)
Committs a creation of a new directory/directories in the repository. | | public ISVNCommitHandler | getCommitHandler()
Returns the specified commit handler (if set) being in use or a default one
(DefaultSVNCommitHandler) if no special
implementations of ISVNCommitHandler were
previousely provided. | | public ISVNCommitParameters | getCommitParameters()
Returns commit parameters. | | public void | setCommitHander(ISVNCommitHandler handler)
| | public void | setCommitHandler(ISVNCommitHandler handler)
Sets an implementation of ISVNCommitHandler to
the commit handler that will be used during commit operations to handle
commit log messages. | | public void | setCommitParameters(ISVNCommitParameters parameters)
Sets commit parameters to use.
When no parameters are set
DefaultSVNCommitParameters default
ones are used. | | static String | validateCommitMessage(String message)
|
| SVNCommitClient | | public SVNCommitClient(ISVNAuthenticationManager authManager, ISVNOptions options)(Code) | | Constructs and initializes an SVNCommitClient object
with the specified run-time configuration and authentication
drivers.
If options is null,
then this SVNCommitClient will be using a default run-time
configuration driver which takes client-side settings from the
default SVN's run-time configuration area but is not able to
change those settings (read more on
ISVNOptions and
SVNWCUtil ).
If authManager is null,
then this SVNCommitClient will be using a default authentication
and network layers driver (see
SVNWCUtil.createDefaultAuthenticationManager )
which uses server-side settings and auth storage from the
default SVN's run-time configuration area (or system properties
if that area is not found).
Parameters:
authManager - an authentication and network layers driver
Parameters:
options - a run-time configuration options driver |
| doCollectCommitItems | | public SVNCommitPacket doCollectCommitItems(File[] paths, boolean keepLocks, boolean force, boolean recursive) throws SVNException(Code) | | Collects commit items (containing detailed information on each Working Copy item
that was changed and need to be committed to the repository) into a single
SVNCommitPacket. Further this commit packet can be passed to
SVNCommitClient.doCommit(SVNCommitPacket,boolean,String) doCommit() .
Parameters:
paths - an array of local items which should be traversedto collect information on every changed item (one SVNCommitItem per eachmodified local item)
Parameters:
keepLocks - if true and there are local items that were locked then these items will be left locked aftertraversing all of them, otherwise the items will be unlocked
Parameters:
force - forces collecting commit items for a non-recursive commit
Parameters:
recursive - relevant only for directory items: if true then the entire directory tree will be traversed including all child directories, otherwise only items located in the directory itselfwill be processed an SVNCommitPacket containingall Working Copy items having local modifications and represented as SVNCommitItem objects; if no modifieditems were found then SVNCommitPacket.EMPTY is returned
throws:
SVNException -
See Also: SVNCommitItem |
| doCollectCommitItems | | public SVNCommitPacket[] doCollectCommitItems(File[] paths, boolean keepLocks, boolean force, boolean recursive, boolean combinePackets) throws SVNException(Code) | | Collects commit items (containing detailed information on each Working Copy item
that was changed and need to be committed to the repository) into different
SVNCommitPackets. This allows to prepare commit packets for different
Working Copies located "belonging" different repositories. Separate packets will
be committed separately. If the repository is the same for all the paths, then all
collected commit packets can be combined into a single one and committed in a single
transaction.
Parameters:
paths - an array of local items which should be traversedto collect information on every changed item (one SVNCommitItem per eachmodified local item)
Parameters:
keepLocks - if true and there are local items that were locked then these items will be left locked aftertraversing all of them, otherwise the items will be unlocked
Parameters:
force - forces collecting commit items for a non-recursive commit
Parameters:
recursive - relevant only for directory items: if true then the entire directory tree will be traversed including all child directories, otherwise only items located in the directory itselfwill be processed
Parameters:
combinePackets - if true then collected commitpackets will be joined into a single one, so that to be committedin a single transaction an array of commit packets
throws:
SVNException -
See Also: SVNCommitItem |
| doCommit | | public SVNCommitInfo doCommit(File[] paths, boolean keepLocks, String commitMessage, boolean force, boolean recursive) throws SVNException(Code) | | Committs local changes made to the Working Copy items (provided as an array of
java.io.File s) to the repository.
Parameters:
paths - an array of local items which should be traversedto commit changes they have to the repository
Parameters:
keepLocks - if true and there are local items that were locked then the commit will left them locked,otherwise the items will be unlocked after the commitsucceeds
Parameters:
commitMessage - a string to be a commit log message
Parameters:
force - true to force a non-recursive commit; ifrecursive is set to true the forceflag is ignored
Parameters:
recursive - relevant only for directory items: if true then the entire directory tree will be committed including all child directories, otherwise only items located in the directory itself information on a new revision as the resultof the commit
throws:
SVNException -
See Also: SVNCommitClient.doCommit(SVNCommitPacket,boolean,String)
See Also: |
| doCommit | | public SVNCommitInfo doCommit(SVNCommitPacket commitPacket, boolean keepLocks, String commitMessage) throws SVNException(Code) | | Committs local changes made to the Working Copy items to the repository.
commitPacket contains commit items (SVNCommitItem)
which represent local Working Copy items that were changed and are to be committed.
Commit items are gathered in a single SVNCommitPacket
by invoking
SVNCommitClient.doCollectCommitItems(File[],boolean,boolean,boolean) doCollectCommitItems() .
Parameters:
commitPacket - a single object that contains items to be committed
Parameters:
keepLocks - if true and there are local items that were locked then the commit will left them locked,otherwise the items will be unlocked after the commitsucceeds
Parameters:
commitMessage - a string to be a commit log message information on a new revision as the resultof the commit
throws:
SVNException -
See Also: SVNCommitItem |
| doCommit | | public SVNCommitInfo[] doCommit(SVNCommitPacket[] commitPackets, boolean keepLocks, String commitMessage) throws SVNException(Code) | | Committs local changes, made to the Working Copy items, to the repository.
commitPackets is an array of packets that contain commit items (SVNCommitItem)
which represent local Working Copy items that were changed and are to be committed.
Commit items are gathered in a single SVNCommitPacket
by invoking
SVNCommitClient.doCollectCommitItems(File[],boolean,boolean,boolean) doCollectCommitItems() .
This allows to commit separate trees of Working Copies "belonging" to different
repositories. One packet per one repository. If repositories are different (it means more than
one commit will be done), commitMessage may be replaced by a commit handler
to be a specific one for each commit.
Parameters:
commitPackets - logically grouped items to be committed
Parameters:
keepLocks - if true and there are local items that were locked then the commit will left them locked,otherwise the items will be unlocked after the commitsucceeds
Parameters:
commitMessage - a string to be a commit log message committed information
throws:
SVNException - |
| doDelete | | public SVNCommitInfo doDelete(SVNURL[] urls, String commitMessage) throws SVNException(Code) | | Committs removing specified URL-paths from the repository.
Parameters:
urls - an array containing URL-strings that representrepository locations to be removed
Parameters:
commitMessage - a string to be a commit log message information on a new revision as the resultof the commit
throws:
SVNException - if one of the following is true:- a URL does not exist
- probably some of URLs refer to differentrepositories
|
| doImport | | public SVNCommitInfo doImport(File path, SVNURL dstURL, String commitMessage, boolean recursive) throws SVNException(Code) | | Committs an addition of a local unversioned file or directory into
the repository. If the destination URL (dstURL) contains any
non-existent parent directories they will be automatically created by the
server.
Parameters:
path - a local unversioned file or directory to be importedinto the repository
Parameters:
dstURL - a URL-string that represents a repository locationwhere the path will be imported
Parameters:
commitMessage - a string to be a commit log message
Parameters:
recursive - this flag is relevant only when the path is a directory: if true then the entire directorytree will be imported including all child directories, otherwise only items located in the directory itself information on a new revision as the resultof the commit
throws:
SVNException - if one of the following is true:dstURL is invalid- the path denoted by
dstURL alreadyexists path contains a reserved name - '.svn'
|
| doImport | | public SVNCommitInfo doImport(File path, SVNURL dstURL, String commitMessage, boolean useGlobalIgnores, boolean recursive) throws SVNException(Code) | | Committs an addition of a local unversioned file or directory into
the repository. If the destination URL (dstURL) contains any
non-existent parent directories they will be automatically created by the
server.
Parameters:
path - a local unversioned file or directory to be importedinto the repository
Parameters:
dstURL - a URL-string that represents a repository locationwhere the path will be imported
Parameters:
commitMessage - a string to be a commit log message
Parameters:
useGlobalIgnores - if true then those paths that match global ignore patterns controlled by a config options driver (see ISVNOptions.isIgnored(String) isIgnored()) will not be imported, otherwise global ignore patterns are not used
Parameters:
recursive - this flag is relevant only when the path is a directory: if true then the entire directorytree will be imported including all child directories, otherwise only items located in the directory itself information on a new revision as the resultof the commit
throws:
SVNException - if one of the following is true:dstURL is invalid- the path denoted by
dstURL alreadyexists path contains a reserved name - '.svn'
|
| doMkDir | | public SVNCommitInfo doMkDir(SVNURL[] urls, String commitMessage) throws SVNException(Code) | | Committs a creation of a new directory/directories in the repository.
Parameters:
urls - an array containing URL-strings that representnew repository locations to be created
Parameters:
commitMessage - a string to be a commit log message information on a new revision as the resultof the commit
throws:
SVNException - if some of URLs refer to differentrepositories |
| setCommitHandler | | public void setCommitHandler(ISVNCommitHandler handler)(Code) | | Sets an implementation of ISVNCommitHandler to
the commit handler that will be used during commit operations to handle
commit log messages. The handler will receive a clien's log message and items
(represented as SVNCommitItem objects) that will be
committed. Depending on implementor's aims the initial log message can
be modified (or something else) and returned back.
If using SVNCommitClient without specifying any
commit handler then a default one will be used -
DefaultSVNCommitHandler .
Parameters:
handler - an implementor's handler that will be used to handle commit log messages
See Also: SVNCommitClient.getCommitHandler()
See Also: ISVNCommitHandler |
| Methods inherited from org.tmatesoft.svn.core.wc.SVNBasicClient | public void checkCancelled() throws SVNCancelException(Code)(Java Doc)
protected SVNRepository createRepository(SVNURL url, boolean mayReuse) throws SVNException(Code)(Java Doc)
protected SVNRepository createRepository(SVNURL url, File path, SVNRevision pegRevision, SVNRevision revision) throws SVNException(Code)(Java Doc)
protected SVNRepository createRepository(SVNURL url, File path, SVNRevision pegRevision, SVNRevision revision, long[] pegRev) throws SVNException(Code)(Java Doc)
protected SVNWCAccess createWCAccess()(Code)(Java Doc)
protected SVNWCAccess createWCAccess(String pathPrefix)(Code)(Java Doc)
protected void dispatchEvent(SVNEvent event) throws SVNException(Code)(Java Doc)
protected void dispatchEvent(SVNEvent event, double progress) throws SVNException(Code)(Java Doc)
public ISVNDebugLog getDebugLog()(Code)(Java Doc)
protected ISVNEventHandler getEventDispatcher()(Code)(Java Doc)
protected SVNRepositoryLocation[] getLocations(SVNURL url, File path, SVNRepository repository, SVNRevision revision, SVNRevision start, SVNRevision end) throws SVNException(Code)(Java Doc)
public ISVNOptions getOptions()(Code)(Java Doc)
protected ISVNRepositoryPool getRepositoryPool()(Code)(Java Doc)
protected long getRevisionNumber(SVNRevision revision, SVNRepository repository, File path) throws SVNException(Code)(Java Doc)
protected SVNURL getURL(File path) throws SVNException(Code)(Java Doc)
public void handleEvent(SVNEvent event, double progress) throws SVNException(Code)(Java Doc)
public boolean isIgnoreExternals()(Code)(Java Doc)
public boolean isLeaveConflictsUnresolved()(Code)(Java Doc)
public void setDebugLog(ISVNDebugLog log)(Code)(Java Doc)
public void setEventHandler(ISVNEventHandler dispatcher)(Code)(Java Doc)
public void setEventPathPrefix(String prefix)(Code)(Java Doc)
public void setIgnoreExternals(boolean ignore)(Code)(Java Doc)
public void setLeaveConflictsUnresolved(boolean leave)(Code)(Java Doc)
public void setOptions(ISVNOptions options)(Code)(Java Doc)
protected void sleepForTimeStamp()(Code)(Java Doc)
|
|
|