Java Doc for SVNWCClient.java in  » Source-Control » tmatesoft-SVN » org » tmatesoft » svn » core » wc » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Source Control » tmatesoft SVN » org.tmatesoft.svn.core.wc 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.tmatesoft.svn.core.wc.SVNBasicClient
      org.tmatesoft.svn.core.wc.SVNWCClient

SVNWCClient
public class SVNWCClient extends SVNBasicClient (Code)
The SVNWCClient class combines a number of version control operations mainly intended for local work with Working Copy items. This class includes those operations that are destined only for local work on a Working Copy as well as those that are moreover able to access a repository.

Here's a list of the SVNWCClient's methods matched against corresponing commands of the SVN command line client:
SVNKit Subversion
doAdd()'svn add'
doDelete()'svn delete'
doCleanup()'svn cleanup'
doInfo()'svn info'
doLock()'svn lock'
doUnlock()'svn unlock'
doSetProperty() 'svn propset PROPNAME PROPVAL PATH'
'svn propdel PROPNAME PATH'
'svn propedit PROPNAME PATH'
doSetRevisionProperty() 'svn propset PROPNAME --revprop -r REV PROPVAL [URL]'
'svn propdel PROPNAME --revprop -r REV [URL]'
'svn propedit PROPNAME --revprop -r REV [URL]'
doGetProperty() 'svn propget PROPNAME PATH'
'svn proplist PATH'
doGetRevisionProperty() 'svn propget PROPNAME --revprop -r REV [URL]'
'svn proplist --revprop -r REV [URL]'
doResolve()'svn resolved'
doRevert()'svn revert'

version:
   1.1.1
author:
   TMate Software Ltd.
See Also:    Examples



Field Summary
public static  ISVNAddParametersDEFAULT_ADD_PARAMETERS
    

Constructor Summary
public  SVNWCClient(ISVNAuthenticationManager authManager, ISVNOptions options)
     Constructs and initializes an SVNWCClient object with the specified run-time configuration and authentication drivers.

If options is null, then this SVNWCClient 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 ).

public  SVNWCClient(ISVNRepositoryPool repositoryPool, ISVNOptions options)
    

Method Summary
public  voiddoAdd(File path, boolean force, boolean mkdir, boolean climbUnversionedParents, boolean recursive)
     Schedules an unversioned item for addition to a repository thus putting it under version control.

To create and add to version control a new directory, set mkdir to true.

public  voiddoAdd(File path, boolean force, boolean mkdir, boolean climbUnversionedParents, boolean recursive, boolean includeIgnored)
     Schedules an unversioned item for addition to a repository thus putting it under version control.

To create and add to version control a new directory, set mkdir to true.

public  voiddoCleanup(File path)
     Recursively cleans up the working copy, removing locks and resuming unfinished operations.
public  voiddoCleanup(File path, boolean deleteWCProperties)
    
public  voiddoCleanupWCProperties(File directory)
    
public  voiddoDelete(File path, boolean force, boolean dryRun)
     Schedules a Working Copy item for deletion.
public  voiddoDelete(File path, boolean force, boolean deleteFiles, boolean dryRun)
     Schedules a Working Copy item for deletion.
public  voiddoGetFileContents(File path, SVNRevision pegRevision, SVNRevision revision, boolean expandKeywords, OutputStream dst)
     Gets contents of a file.
public  voiddoGetFileContents(SVNURL url, SVNRevision pegRevision, SVNRevision revision, boolean expandKeywords, OutputStream dst)
     Gets contents of a file of a particular revision from a repository.
public  SVNPropertyDatadoGetProperty(File path, String propName, SVNRevision pegRevision, SVNRevision revision, boolean recursive)
     Gets an item's versioned property.
public  SVNPropertyDatadoGetProperty(SVNURL url, String propName, SVNRevision pegRevision, SVNRevision revision, boolean recursive)
     Gets an item's versioned property from a repository.
public  voiddoGetProperty(File path, String propName, SVNRevision pegRevision, SVNRevision revision, boolean recursive, ISVNPropertyHandler handler)
     Gets an item's versioned property and passes it to a provided property handler.
public  voiddoGetProperty(SVNURL url, String propName, SVNRevision pegRevision, SVNRevision revision, boolean recursive, ISVNPropertyHandler handler)
     Gets an item's versioned property from a repository and passes it to a provided property handler.
public  voiddoGetRevisionProperty(File path, String propName, SVNRevision revision, ISVNPropertyHandler handler)
     Gets an unversioned revision property from a repository (getting a repository URL from a Working Copy) and passes it to a provided property handler.
public  voiddoGetRevisionProperty(SVNURL url, String propName, SVNRevision revision, ISVNPropertyHandler handler)
     Gets an unversioned revision property from a repository and passes it to a provided property handler.
public  StringdoGetWorkingCopyID(File path, String trailURL)
     Returns the current Working Copy min- and max- revisions as well as changes and switch status within a single string.

A return string has a form of "minR[:maxR][M][S]" where:

  • minR - is the smallest revision number met in the Working Copy
  • maxR - is the biggest revision number met in the Working Copy; appears only if there are different revision in the Working Copy
  • M - appears only if there're local edits to the Working Copy - that means 'Modified'
  • S - appears only if the Working Copy is switched against a different URL
If path is a directory - this method recursively descends into the Working Copy, collects and processes local information.
public  StringdoGetWorkingCopyID(File path, String trailURL, boolean committed)
    
public  voiddoInfo(File path, SVNRevision revision, boolean recursive, ISVNInfoHandler handler)
     Collects information about Working Copy item(s) and passes it to an info handler.
public  voiddoInfo(File path, SVNRevision pegRevision, SVNRevision revision, boolean recursive, ISVNInfoHandler handler)
     Collects information about Working Copy item(s) and passes it to an info handler.
public  voiddoInfo(SVNURL url, SVNRevision pegRevision, SVNRevision revision, boolean recursive, ISVNInfoHandler handler)
     Collects information about item(s) in a repository and passes it to an info handler.
public  SVNInfodoInfo(File path, SVNRevision revision)
     Collects and returns information on a single Working Copy item.

If revision is valid and not SVNRevision.WORKING WORKING then information will be collected on remote items (that is taken from a repository).

public  SVNInfodoInfo(SVNURL url, SVNRevision pegRevision, SVNRevision revision)
     Collects and returns information on a single item in a repository.
public  voiddoLock(File[] paths, boolean stealLock, String lockMessage)
     Locks file items in a Working Copy as well as in a repository so that no other user can commit changes to them.
public  voiddoLock(SVNURL[] urls, boolean stealLock, String lockMessage)
     Locks file items in a repository so that no other user can commit changes to them.
public  voiddoResolve(File path, boolean recursive)
     Resolves a 'conflicted' state on a Working Copy item.
public  voiddoRevert(File path, boolean recursive)
     Reverts all local changes made to a Working Copy item(s) thus bringing it to a 'pristine' state.
public  voiddoRevert(File[] paths, boolean recursive)
     Reverts all local changes made to a Working Copy item(s) thus bringing it to a 'pristine' state.
Parameters:
  paths - a WC paths to perform a revert on
Parameters:
  recursive - true todescend recursively (relevant for directories)
throws:
  SVNException - if one of the following is true:
  • path is not under version control
  • when trying to revert an addition of a directoryfrom within the directory itself
Exception will not be thrown if there are multiple paths passed.
public  voiddoSetProperty(File path, String propName, String propValue, boolean force, boolean recursive, ISVNPropertyHandler handler)
     Sets, edits or deletes a property on a file or directory item(s).

To set or edit a property simply provide a propName and a propValue.

public  voiddoSetRevisionProperty(File path, SVNRevision revision, String propName, String propValue, boolean force, ISVNPropertyHandler handler)
     Sets, edits or deletes an unversioned revision property. This method uses a Working Copy item to obtain the URL of the repository which revision properties are to be changed.

To set or edit a property simply provide a propName and a propValue.

public  voiddoSetRevisionProperty(SVNURL url, SVNRevision revision, String propName, String propValue, boolean force, ISVNPropertyHandler handler)
     Sets, edits or deletes an unversioned revision property. This method uses a URL pointing to a repository which revision properties are to be changed.

To set or edit a property simply provide a propName and a propValue.

public  voiddoUnlock(File[] paths, boolean breakLock)
     Unlocks file items in a Working Copy as well as in a repository.
public  voiddoUnlock(SVNURL[] urls, boolean breakLock)
     Unlocks file items in a repository.
protected  ISVNAddParametersgetAddParameters()
    
public  voidsetAddParameters(ISVNAddParameters addParameters)
    

Field Detail
DEFAULT_ADD_PARAMETERS
public static ISVNAddParameters DEFAULT_ADD_PARAMETERS(Code)




Constructor Detail
SVNWCClient
public SVNWCClient(ISVNAuthenticationManager authManager, ISVNOptions options)(Code)
Constructs and initializes an SVNWCClient object with the specified run-time configuration and authentication drivers.

If options is null, then this SVNWCClient 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 SVNWCClient 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




SVNWCClient
public SVNWCClient(ISVNRepositoryPool repositoryPool, ISVNOptions options)(Code)




Method Detail
doAdd
public void doAdd(File path, boolean force, boolean mkdir, boolean climbUnversionedParents, boolean recursive) throws SVNException(Code)
Schedules an unversioned item for addition to a repository thus putting it under version control.

To create and add to version control a new directory, set mkdir to true.

Calling this method is equivalent to doAdd(path, force, mkdir, climbUnversionedParents, recursive, false).
Parameters:
  path - a path to be put under version control (will be added to a repositoryin next commit)
Parameters:
  force - when true forces the operation to run on already versioned files or directories without reporting error. When ran recursively, all unversioned files and directories in a tree will be scheduled for addition.
Parameters:
  mkdir - if true - creates a new directory and schedules it foraddition
Parameters:
  climbUnversionedParents - if true andpath is located in an unversionedparent directory then the parent will be automaticallyscheduled for addition, too
Parameters:
  recursive - true todescend recursively (relevant for directories)
throws:
  SVNException - if one of the following is true:

  • path doesn't belongto a Working Copy
  • path doesn't exist andmkdir is false
  • path is the root directory of the Working Copy



doAdd
public void doAdd(File path, boolean force, boolean mkdir, boolean climbUnversionedParents, boolean recursive, boolean includeIgnored) throws SVNException(Code)
Schedules an unversioned item for addition to a repository thus putting it under version control.

To create and add to version control a new directory, set mkdir to true.
Parameters:
  path - a path to be put under version control (will be added to a repositoryin next commit)
Parameters:
  force - when true forces the operation to run on already versioned files or directories without reporting error. When ran recursively, all unversioned files and directories in a tree will be scheduled for addition.
Parameters:
  mkdir - if true - creates a new directory and schedules it foraddition
Parameters:
  climbUnversionedParents - if true andpath is located in an unversionedparent directory then the parent will be automaticallyscheduled for addition, too
Parameters:
  recursive - true todescend recursively (relevant for directories)
Parameters:
  includeIgnored - controls whether ignored items must be also added
throws:
  SVNException - if one of the following is true:

  • path doesn't belongto a Working Copy
  • path doesn't exist andmkdir is false
  • path is the root directory of the Working Copy

since:
   1.1



doCleanup
public void doCleanup(File path) throws SVNException(Code)
Recursively cleans up the working copy, removing locks and resuming unfinished operations.

If you ever get a "working copy locked" error, use this method to remove stale locks and get your working copy into a usable state again.
Parameters:
  path - a WC path to start a cleanup from
throws:
  SVNException - if one of the following is true:

  • path does not exist
  • path's parent directoryis not under version control



doCleanup
public void doCleanup(File path, boolean deleteWCProperties) throws SVNException(Code)



doCleanupWCProperties
public void doCleanupWCProperties(File directory) throws SVNException(Code)



doDelete
public void doDelete(File path, boolean force, boolean dryRun) throws SVNException(Code)
Schedules a Working Copy item for deletion.
Parameters:
  path - a WC item to be deleted
Parameters:
  force - true toforce the operation to run
Parameters:
  dryRun - true only totry the delete operation without actual deleting
throws:
  SVNException - if one of the following is true:
  • path is not under version control
  • can not delete path without forcing

See Also:   SVNWCClient.doDelete(File,boolean,boolean,boolean)



doDelete
public void doDelete(File path, boolean force, boolean deleteFiles, boolean dryRun) throws SVNException(Code)
Schedules a Working Copy item for deletion. This method allows to choose - whether file item(s) are to be deleted from the filesystem or not. Another version of the SVNWCClient.doDelete(File,boolean,boolean) doDelete() method is similar to the corresponding SVN client's command - 'svn delete' as it always deletes files from the filesystem.
Parameters:
  path - a WC item to be deleted
Parameters:
  force - true toforce the operation to run
Parameters:
  deleteFiles - if true thenfiles will be scheduled for deletion as well asdeleted from the filesystem, otherwise files willbe only scheduled for addition and still be presentin the filesystem
Parameters:
  dryRun - true only totry the delete operation without actual deleting
throws:
  SVNException - if one of the following is true:
  • path is not under version control
  • can not delete path without forcing



doGetFileContents
public void doGetFileContents(File path, SVNRevision pegRevision, SVNRevision revision, boolean expandKeywords, OutputStream dst) throws SVNException(Code)
Gets contents of a file. If revision is one of: then the file contents are taken from the Working Copy file item. Otherwise the file item's contents are taken from the repository at a particular revision.
Parameters:
  path - a Working Copy file item
Parameters:
  pegRevision - a revision in which the file item is first looked up
Parameters:
  revision - a target revision
Parameters:
  expandKeywords - if true thenall keywords presenting in the file and listed in the file's org.tmatesoft.svn.core.SVNProperty.KEYWORDS svn:keywordsproperty (if set) will be substituted, otherwise not
Parameters:
  dst - the destination where the file contents will be written to
throws:
  SVNException - if one of the following is true:
  • path refers to a directory
  • path does not exist
  • path is not under version control

See Also:   SVNWCClient.doGetFileContents(SVNURL,SVNRevision,SVNRevision,boolean,OutputStream)
See Also:   



doGetFileContents
public void doGetFileContents(SVNURL url, SVNRevision pegRevision, SVNRevision revision, boolean expandKeywords, OutputStream dst) throws SVNException(Code)
Gets contents of a file of a particular revision from a repository.
Parameters:
  url - a file item's repository location
Parameters:
  pegRevision - a revision in which the file item is first looked up
Parameters:
  revision - a target revision
Parameters:
  expandKeywords - if true thenall keywords presenting in the file and listed in the file's org.tmatesoft.svn.core.SVNProperty.KEYWORDS svn:keywordsproperty (if set) will be substituted, otherwise not
Parameters:
  dst - the destination where the file contents will be written to
throws:
  SVNException - if one of the following is true:
See Also:   SVNWCClient.doGetFileContents(File,SVNRevision,SVNRevision,boolean,OutputStream)
See Also:   



doGetProperty
public SVNPropertyData doGetProperty(File path, String propName, SVNRevision pegRevision, SVNRevision revision, boolean recursive) throws SVNException(Code)
Gets an item's versioned property. It's possible to get either a local property (from a Working Copy) or a remote one (located in a repository). If revision is one of: then the result is a WC item's property. Otherwise the property is taken from a repository (using the item's URL).
Parameters:
  path - a WC item's path
Parameters:
  propName - an item's property name; if it's null thenall the item's properties will be retrievedbut only the first of them returned
Parameters:
  pegRevision - a revision in which the item is first looked up
Parameters:
  revision - a target revision;
Parameters:
  recursive - true todescend recursively the item's property
throws:
  SVNException - if one of the following is true:
See Also:   SVNWCClient.doGetProperty(File,String,SVNRevision,SVNRevision,boolean,ISVNPropertyHandler)
See Also:   SVNWCClient.doSetProperty(File,String,String,boolean,boolean,ISVNPropertyHandler)



doGetProperty
public SVNPropertyData doGetProperty(SVNURL url, String propName, SVNRevision pegRevision, SVNRevision revision, boolean recursive) throws SVNException(Code)
Gets an item's versioned property from a repository. This method is useful when having no Working Copy at all.
Parameters:
  url - an item's repository location
Parameters:
  propName - an item's property name; if it's null thenall the item's properties will be retrievedbut only the first of them returned
Parameters:
  pegRevision - a revision in which the item is first looked up
Parameters:
  revision - a target revision
Parameters:
  recursive - true todescend recursively the item's property
throws:
  SVNException - if propName startswith the org.tmatesoft.svn.core.SVNProperty.SVN_WC_PREFIXsvn:wc: prefix
See Also:   SVNWCClient.doGetProperty(SVNURL,String,SVNRevision,SVNRevision,boolean,ISVNPropertyHandler)
See Also:   SVNWCClient.doSetProperty(File,String,String,boolean,boolean,ISVNPropertyHandler)



doGetProperty
public void doGetProperty(File path, String propName, SVNRevision pegRevision, SVNRevision revision, boolean recursive, ISVNPropertyHandler handler) throws SVNException(Code)
Gets an item's versioned property and passes it to a provided property handler. It's possible to get either a local property (from a Working Copy) or a remote one (located in a repository). If revision is one of: then the result is a WC item's property. Otherwise the property is taken from a repository (using the item's URL).
Parameters:
  path - a WC item's path
Parameters:
  propName - an item's property name; if it's null thenall the item's properties will be retrievedand passed to handler forprocessing
Parameters:
  pegRevision - a revision in which the item is first looked up
Parameters:
  revision - a target revision;
Parameters:
  recursive - true todescend recursively
Parameters:
  handler - a caller's property handler
throws:
  SVNException - if one of the following is true:
See Also:   SVNWCClient.doGetProperty(File,String,SVNRevision,SVNRevision,boolean)
See Also:   SVNWCClient.doSetProperty(File,String,String,boolean,boolean,ISVNPropertyHandler)



doGetProperty
public void doGetProperty(SVNURL url, String propName, SVNRevision pegRevision, SVNRevision revision, boolean recursive, ISVNPropertyHandler handler) throws SVNException(Code)
Gets an item's versioned property from a repository and passes it to a provided property handler. This method is useful when having no Working Copy at all.
Parameters:
  url - an item's repository location
Parameters:
  propName - an item's property name; if it's null thenall the item's properties will be retrievedand passed to handler forprocessing
Parameters:
  pegRevision - a revision in which the item is first looked up
Parameters:
  revision - a target revision
Parameters:
  recursive - true todescend recursively
Parameters:
  handler - a caller's property handler
throws:
  SVNException - if propName startswith the org.tmatesoft.svn.core.SVNProperty.SVN_WC_PREFIXsvn:wc: prefix
See Also:   SVNWCClient.doGetProperty(SVNURL,String,SVNRevision,SVNRevision,boolean)
See Also:   SVNWCClient.doSetProperty(File,String,String,boolean,boolean,ISVNPropertyHandler)



doGetRevisionProperty
public void doGetRevisionProperty(File path, String propName, SVNRevision revision, ISVNPropertyHandler handler) throws SVNException(Code)
Gets an unversioned revision property from a repository (getting a repository URL from a Working Copy) and passes it to a provided property handler.
Parameters:
  path - a local Working Copy item which repositorylocation is used to connect to a repository
Parameters:
  propName - a revision property name; if this parameter is null thenall the revision properties will be retrievedand passed to handler forprocessing
Parameters:
  revision - a revision which property is to be retrieved
Parameters:
  handler - a caller's property handler
throws:
  SVNException - if one of the following is true:
See Also:   SVNWCClient.doGetRevisionProperty(SVNURL,String,SVNRevision,ISVNPropertyHandler)
See Also:   SVNWCClient.doSetRevisionProperty(File,SVNRevision,String,String,boolean,ISVNPropertyHandler)



doGetRevisionProperty
public void doGetRevisionProperty(SVNURL url, String propName, SVNRevision revision, ISVNPropertyHandler handler) throws SVNException(Code)
Gets an unversioned revision property from a repository and passes it to a provided property handler.
Parameters:
  url - a URL pointing to a repository locationwhich revision property is to be got
Parameters:
  propName - a revision property name; if this parameter is null thenall the revision properties will be retrievedand passed to handler forprocessing
Parameters:
  revision - a revision which property is to be retrieved
Parameters:
  handler - a caller's property handler
throws:
  SVNException - if one of the following is true:
See Also:   SVNWCClient.doGetRevisionProperty(File,String,SVNRevision,ISVNPropertyHandler)
See Also:   SVNWCClient.doSetRevisionProperty(SVNURL,SVNRevision,String,String,boolean,ISVNPropertyHandler)



doGetWorkingCopyID
public String doGetWorkingCopyID(File path, String trailURL) throws SVNException(Code)
Returns the current Working Copy min- and max- revisions as well as changes and switch status within a single string.

A return string has a form of "minR[:maxR][M][S]" where:

  • minR - is the smallest revision number met in the Working Copy
  • maxR - is the biggest revision number met in the Working Copy; appears only if there are different revision in the Working Copy
  • M - appears only if there're local edits to the Working Copy - that means 'Modified'
  • S - appears only if the Working Copy is switched against a different URL
If path is a directory - this method recursively descends into the Working Copy, collects and processes local information.
Parameters:
  path - a local path
Parameters:
  trailURL - optional: if not nullspecifies the name of the item that should be met in the URL corresponding to the repository locationof the path; if that URL ends with somethingdifferent than this optional parameter - the WorkingCopy will be considered "switched" brief info on the Working Copy or the string "exported" if path is a clean directory
throws:
  SVNException - if path is neither versioned noreven exported



doGetWorkingCopyID
public String doGetWorkingCopyID(File path, String trailURL, boolean committed) throws SVNException(Code)



doInfo
public void doInfo(File path, SVNRevision revision, boolean recursive, ISVNInfoHandler handler) throws SVNException(Code)
Collects information about Working Copy item(s) and passes it to an info handler.

If revision is valid and not local, then information will be collected on remote items (that is taken from a repository). Otherwise information is gathered on local items not accessing a repository.
Parameters:
  path - a WC item on which info should be obtained
Parameters:
  revision - a target revision
Parameters:
  recursive - true todescend recursively (relevant for directories)
Parameters:
  handler - a caller's info handler
throws:
  SVNException - if one of the following is true:

  • path is not under version control
  • can not obtain a URL corresponding to path to get its information from the repository - there's no such entry
  • if a remote info: path is an item that does not exist inthe specified revision

See Also:   SVNWCClient.doInfo(File,SVNRevision)
See Also:   SVNWCClient.doInfo(SVNURL,SVNRevision,SVNRevision,boolean,ISVNInfoHandler)



doInfo
public void doInfo(File path, SVNRevision pegRevision, SVNRevision revision, boolean recursive, ISVNInfoHandler handler) throws SVNException(Code)
Collects information about Working Copy item(s) and passes it to an info handler.

If revision & pegRevision are valid and not local, then information will be collected on remote items (that is taken from a repository). Otherwise information is gathered on local items not accessing a repository.
Parameters:
  path - a WC item on which info should be obtained
Parameters:
  pegRevision - a revision in which path is first looked up
Parameters:
  revision - a target revision
Parameters:
  recursive - true todescend recursively (relevant for directories)
Parameters:
  handler - a caller's info handler
throws:
  SVNException - if one of the following is true:

  • path is not under version control
  • can not obtain a URL corresponding to path to get its information from the repository - there's no such entry
  • if a remote info: path is an item that does not exist inthe specified revision

See Also:   SVNWCClient.doInfo(File,SVNRevision)
See Also:   SVNWCClient.doInfo(File,SVNRevision,boolean,ISVNInfoHandler)



doInfo
public void doInfo(SVNURL url, SVNRevision pegRevision, SVNRevision revision, boolean recursive, ISVNInfoHandler handler) throws SVNException(Code)
Collects information about item(s) in a repository and passes it to an info handler.
Parameters:
  url - a URL of an item which information is to beobtained and processed
Parameters:
  pegRevision - a revision in which the item is first looked up
Parameters:
  revision - a target revision
Parameters:
  recursive - true todescend recursively (relevant for directories)
Parameters:
  handler - a caller's info handler
throws:
  SVNException - if url is an item that does not exist inthe specified revision
See Also:   SVNWCClient.doInfo(SVNURL,SVNRevision,SVNRevision)
See Also:   SVNWCClient.doInfo(File,SVNRevision,boolean,ISVNInfoHandler)



doInfo
public SVNInfo doInfo(File path, SVNRevision revision) throws SVNException(Code)
Collects and returns information on a single Working Copy item.

If revision is valid and not SVNRevision.WORKING WORKING then information will be collected on remote items (that is taken from a repository). Otherwise information is gathered on local items not accessing a repository.
Parameters:
  path - a WC item on which info should be obtained
Parameters:
  revision - a target revision collected info
throws:
  SVNException - if one of the following is true:

  • path is not under version control
  • can not obtain a URL corresponding to path to get its information from the repository - there's no such entry
  • if a remote info: path is an item that does not exist inthe specified revision

See Also:   SVNWCClient.doInfo(File,SVNRevision,boolean,ISVNInfoHandler)
See Also:   SVNWCClient.doInfo(SVNURL,SVNRevision,SVNRevision)
See Also:   



doInfo
public SVNInfo doInfo(SVNURL url, SVNRevision pegRevision, SVNRevision revision) throws SVNException(Code)
Collects and returns information on a single item in a repository.
Parameters:
  url - a URL of an item which information is to beobtained
Parameters:
  pegRevision - a revision in which the item is first looked up
Parameters:
  revision - a target revision collected info
throws:
  SVNException - if url is an item that does not exist inthe specified revision
See Also:   SVNWCClient.doInfo(SVNURL,SVNRevision,SVNRevision,boolean,ISVNInfoHandler)
See Also:   SVNWCClient.doInfo(File,SVNRevision)



doLock
public void doLock(File[] paths, boolean stealLock, String lockMessage) throws SVNException(Code)
Locks file items in a Working Copy as well as in a repository so that no other user can commit changes to them.
Parameters:
  paths - an array of local WC file paths that should be locked
Parameters:
  stealLock - if true then all existinglocks on the specified paths will be "stolen"
Parameters:
  lockMessage - an optional lock comment
throws:
  SVNException - if one of the following is true:
  • a path to be locked is not under version control
  • can not obtain a URL of a local path to lock it in the repository - there's no such entry
  • paths to be locked belong to different repositories

See Also:   SVNWCClient.doLock(SVNURL[],boolean,String)



doLock
public void doLock(SVNURL[] urls, boolean stealLock, String lockMessage) throws SVNException(Code)
Locks file items in a repository so that no other user can commit changes to them.
Parameters:
  urls - an array of URLs to be locked
Parameters:
  stealLock - if true then all existinglocks on the specified urls will be "stolen"
Parameters:
  lockMessage - an optional lock comment
throws:
  SVNException -
See Also:   SVNWCClient.doLock(File[],boolean,String)



doResolve
public void doResolve(File path, boolean recursive) throws SVNException(Code)
Resolves a 'conflicted' state on a Working Copy item.
Parameters:
  path - a WC item to be resolved
Parameters:
  recursive - true todescend recursively (relevant for directories) - thiswill resolve the entire tree
throws:
  SVNException - if path is not under version control



doRevert
public void doRevert(File path, boolean recursive) throws SVNException(Code)
Reverts all local changes made to a Working Copy item(s) thus bringing it to a 'pristine' state.
Parameters:
  path - a WC path to perform a revert on
Parameters:
  recursive - true todescend recursively (relevant for directories)
throws:
  SVNException - if one of the following is true:
  • path is not under version control
  • when trying to revert an addition of a directoryfrom within the directory itself

See Also:   SVNWCClient.doRevert(File[],boolean)



doRevert
public void doRevert(File[] paths, boolean recursive) throws SVNException(Code)
Reverts all local changes made to a Working Copy item(s) thus bringing it to a 'pristine' state.
Parameters:
  paths - a WC paths to perform a revert on
Parameters:
  recursive - true todescend recursively (relevant for directories)
throws:
  SVNException - if one of the following is true:
  • path is not under version control
  • when trying to revert an addition of a directoryfrom within the directory itself
Exception will not be thrown if there are multiple paths passed. Instead caller should process events received by ISVNEventHandlerinstance to get information on whether certain path was reverted or not.



doSetProperty
public void doSetProperty(File path, String propName, String propValue, boolean force, boolean recursive, ISVNPropertyHandler handler) throws SVNException(Code)
Sets, edits or deletes a property on a file or directory item(s).

To set or edit a property simply provide a propName and a propValue. To delete a property set propValue to null and the property propName will be deleted.
Parameters:
  path - a WC item which properties are to be modified
Parameters:
  propName - a property name
Parameters:
  propValue - a property value
Parameters:
  force - true toforce the operation to run
Parameters:
  recursive - true todescend recursively
Parameters:
  handler - a caller's property handler
throws:
  SVNException - if one of the following is true:


See Also:   SVNWCClient.doSetRevisionProperty(File,SVNRevision,String,String,boolean,ISVNPropertyHandler)
See Also:   SVNWCClient.doGetProperty(File,String,SVNRevision,SVNRevision,boolean)
See Also:   SVNWCClient.doGetRevisionProperty(File,String,SVNRevision,ISVNPropertyHandler)



doSetRevisionProperty
public void doSetRevisionProperty(File path, SVNRevision revision, String propName, String propValue, boolean force, ISVNPropertyHandler handler) throws SVNException(Code)
Sets, edits or deletes an unversioned revision property. This method uses a Working Copy item to obtain the URL of the repository which revision properties are to be changed.

To set or edit a property simply provide a propName and a propValue. To delete a revision property set propValue to null and the property propName will be deleted.
Parameters:
  path - a Working Copy item
Parameters:
  revision - a revision which properties are to bemodified
Parameters:
  propName - a property name
Parameters:
  propValue - a property value
Parameters:
  force - true toforce the operation to run
Parameters:
  handler - a caller's property handler
throws:
  SVNException - if one of the following is true:


See Also:   SVNWCClient.doSetRevisionProperty(SVNURL,SVNRevision,String,String,boolean,ISVNPropertyHandler)
See Also:   SVNWCClient.doSetProperty(File,String,String,boolean,boolean,ISVNPropertyHandler)
See Also:   SVNWCClient.doGetProperty(File,String,SVNRevision,SVNRevision,boolean)
See Also:   SVNWCClient.doGetRevisionProperty(File,String,SVNRevision,ISVNPropertyHandler)
See Also:   



doSetRevisionProperty
public void doSetRevisionProperty(SVNURL url, SVNRevision revision, String propName, String propValue, boolean force, ISVNPropertyHandler handler) throws SVNException(Code)
Sets, edits or deletes an unversioned revision property. This method uses a URL pointing to a repository which revision properties are to be changed.

To set or edit a property simply provide a propName and a propValue. To delete a revision property set propValue to null and the property propName will be deleted.
Parameters:
  url - a URL pointing to a repository location
Parameters:
  revision - a revision which properties are to bemodified
Parameters:
  propName - a property name
Parameters:
  propValue - a property value
Parameters:
  force - true toforce the operation to run
Parameters:
  handler - a caller's property handler
throws:
  SVNException - if one of the following is true:


See Also:   SVNWCClient.doSetRevisionProperty(File,SVNRevision,String,String,boolean,ISVNPropertyHandler)
See Also:   SVNWCClient.doSetProperty(File,String,String,boolean,boolean,ISVNPropertyHandler)
See Also:   SVNWCClient.doGetProperty(File,String,SVNRevision,SVNRevision,boolean)
See Also:   SVNWCClient.doGetRevisionProperty(File,String,SVNRevision,ISVNPropertyHandler)
See Also:   



doUnlock
public void doUnlock(File[] paths, boolean breakLock) throws SVNException(Code)
Unlocks file items in a Working Copy as well as in a repository.
Parameters:
  paths - an array of local WC file paths that should be unlocked
Parameters:
  breakLock - if true and there are locksthat belong to different users then those locks will be alsounlocked - that is "broken"
throws:
  SVNException - if one of the following is true:
  • a path is not under version control
  • can not obtain a URL of a local path to unlock it in the repository - there's no such entry
  • if a path is not locked in the Working Copyand breakLock is false
  • paths to be unlocked belong to different repositories

See Also:   SVNWCClient.doUnlock(SVNURL[],boolean)
See Also:   



doUnlock
public void doUnlock(SVNURL[] urls, boolean breakLock) throws SVNException(Code)
Unlocks file items in a repository.
Parameters:
  urls - an array of URLs that should be unlocked
Parameters:
  breakLock - if true and there are locksthat belong to different users then those locks will be alsounlocked - that is "broken"
throws:
  SVNException -
See Also:   SVNWCClient.doUnlock(File[],boolean)



getAddParameters
protected ISVNAddParameters getAddParameters()(Code)



setAddParameters
public void setAddParameters(ISVNAddParameters addParameters)(Code)



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)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.