|
SVNKit Home | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.tmatesoft.svn.core.wc.SVNBasicClient
org.tmatesoft.svn.core.wc.SVNChangelistClient
The SVNChangelistClient provides API for managing changelists.
Here's a list of the SVNChangelistClient's methods matched against corresponing commands of the SVN command line client:
SVNKit | Subversion |
doAddToChangelist() | 'svn changelist CLNAME TARGET' |
doRemoveFromChangelist() | 'svn changelist --remove TARGET' |
Nested Class Summary |
Nested classes inherited from class org.tmatesoft.svn.core.wc.SVNBasicClient |
SVNBasicClient.RepositoryReference, SVNBasicClient.SVNRepositoryLocation |
Field Summary |
Fields inherited from interface org.tmatesoft.svn.core.wc.ISVNEventHandler |
UNKNOWN |
Fields inherited from interface org.tmatesoft.svn.core.ISVNCanceller |
NULL |
Constructor Summary | |
SVNChangelistClient(ISVNAuthenticationManager authManager,
ISVNOptions options)
Constructs and initializes an SVNChangelistClient object with the specified run-time configuration and authentication drivers. |
|
SVNChangelistClient(ISVNRepositoryPool repositoryPool,
ISVNOptions options)
Constructs and initializes an SVNChangelistClient object with the specified run-time configuration and repository pool object. |
Method Summary | |
void |
addToChangelist(File[] paths,
SVNDepth depth,
String changelist,
String[] changelists)
Deprecated. use doAddToChangelist(File[], SVNDepth, String, String[]) instead |
void |
doAddToChangelist(File[] paths,
SVNDepth depth,
String changelist,
String[] changelists)
Adds each path in paths (recursing to depth as necessary) to
changelist . |
void |
doGetChangeListPaths(Collection changeLists,
Collection targets,
SVNDepth depth,
ISVNChangelistHandler handler)
Gets paths belonging to the specified changelists discovered under the specified targets. |
void |
doGetChangeLists(File path,
Collection changeLists,
SVNDepth depth,
ISVNChangelistHandler handler)
Gets paths belonging to the specified changelists discovered under the specified path. |
void |
doRemoveFromChangelist(File[] paths,
SVNDepth depth,
String[] changelists)
Removes each path in paths (recursing to depth as necessary) from changelists
to which they are currently assigned.
|
void |
getChangeListPaths(Collection changeLists,
Collection targets,
SVNDepth depth,
ISVNChangelistHandler handler)
Deprecated. use doGetChangeListPaths(Collection, Collection, SVNDepth, ISVNChangelistHandler)
instead |
void |
getChangeLists(File path,
Collection changeLists,
SVNDepth depth,
ISVNChangelistHandler handler)
Deprecated. use doGetChangeLists(File, Collection, SVNDepth, ISVNChangelistHandler)
instead |
void |
removeFromChangelist(File[] paths,
SVNDepth depth,
String[] changelists)
Deprecated. use doRemoveFromChangelist(File[], SVNDepth, String[]) instead |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public SVNChangelistClient(ISVNAuthenticationManager authManager, ISVNOptions options)
options
is null,
then this SVNChangelistClient 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 SVNChangelistClient 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).
authManager
- an authentication and network layers driveroptions
- a run-time configuration options driverpublic SVNChangelistClient(ISVNRepositoryPool repositoryPool, ISVNOptions options)
options
is null,
then this SVNChangelistClient 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 repositoryPool
is null,
then SVNRepositoryFactory
will be used to create repository access objects
.
repositoryPool
- a repository pool objectoptions
- a run-time configuration options driverMethod Detail |
public void getChangeLists(File path, Collection changeLists, SVNDepth depth, ISVNChangelistHandler handler) throws SVNException
doGetChangeLists(File, Collection, SVNDepth, ISVNChangelistHandler)
instead
path
- changeLists
- depth
- handler
-
SVNException
public void getChangeListPaths(Collection changeLists, Collection targets, SVNDepth depth, ISVNChangelistHandler handler) throws SVNException
doGetChangeListPaths(Collection, Collection, SVNDepth, ISVNChangelistHandler)
instead
changeLists
- targets
- depth
- handler
-
SVNException
public void addToChangelist(File[] paths, SVNDepth depth, String changelist, String[] changelists) throws SVNException
doAddToChangelist(File[], SVNDepth, String, String[])
instead
paths
- depth
- changelist
- changelists
-
SVNException
public void removeFromChangelist(File[] paths, SVNDepth depth, String[] changelists) throws SVNException
doRemoveFromChangelist(File[], SVNDepth, String[])
instead
paths
- depth
- changelists
-
SVNException
public void doAddToChangelist(File[] paths, SVNDepth depth, String changelist, String[] changelists) throws SVNException
paths
(recursing to depth
as necessary) to
changelist
. If a path is already a member of another changelist, then removes it from the
other changelist and adds it to changelist
. (For now, a path cannot belong to two
changelists at once.)
changelists
is an array of String
changelist names, used as a restrictive
filter on items whose changelist assignments are adjusted; that is, doesn't tweak the changeset of any
item unless it's currently a member of one of those changelists. If changelists
is empty
(or null), no changelist filtering occurs.
Note: this metadata is purely a client-side "bookkeeping" convenience, and is entirely managed by the
working copy.
Note: this method does not require repository access.
paths
- working copy paths to add to changelist
depth
- tree depth to processchangelist
- name of the changelist to add new paths tochangelists
- collection of changelist names as a filter
SVNException
public void doRemoveFromChangelist(File[] paths, SVNDepth depth, String[] changelists) throws SVNException
paths
(recursing to depth
as necessary) from changelists
to which they are currently assigned.
changelists
is an array of String
changelist names, used as a restrictive
filter on items whose changelist assignments are removed; that is, doesn't remove from a changeset any
item unless it's currently a member of one of those changelists. If changelists
is empty
(or null), all changelist assignments in and under each path in
paths
(to depth
) will be removed.
Note: this metadata is purely a client-side "bookkeeping" convenience, and is entirely managed by the
working copy.
Note: this method does not require repository access.
paths
- paths to remove from any changelistsdepth
- tree depth to processchangelists
- collection of changelist names as a filter
SVNException
public void doGetChangeListPaths(Collection changeLists, Collection targets, SVNDepth depth, ISVNChangelistHandler handler) throws SVNException
doGetChangeLists(File, Collection, SVNDepth, ISVNChangelistHandler)
except for it operates on multiple targets instead of a single one.
Note: this method does not require repository access.
changeLists
- collection of changelist namestargets
- working copy paths to operate ondepth
- tree depth to processhandler
- caller's handler to receive path-to-changelist information
SVNException
public void doGetChangeLists(File path, Collection changeLists, SVNDepth depth, ISVNChangelistHandler handler) throws SVNException
path
, crawls to depth
to discover every path in or under
path which belongs to one of the changelists in changeLists
(a collection of
String
changelist names).
If changeLists
is null, discovers paths with any changelist.
Calls handler
each time a changelist-having path is discovered.
If there was an event handler provided via SVNBasicClient.setEventHandler(ISVNEventHandler)
, then its
ISVNCanceller.checkCancelled()
will be invoked during the recursive walk.
Note: this method does not require repository access.
- Parameters:
path
- target working copy pathchangeLists
- collection of changelist namesdepth
- tree depth to processhandler
- caller's handler to receive path-to-changelist information
- Throws:
SVNException
- Since:
- 1.2.0, New in SVN 1.5.0
|
SVNKit Home | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |