Class SVNUpdateClient
Here's a list of the SVNUpdateClient's methods matched against corresponing commands of the SVN command line client:
| SVNKit | Subversion |
| doCheckout() | 'svn checkout' |
| doUpdate() | 'svn update' |
| doSwitch() | 'svn switch' |
| doRelocate() | 'svn switch --relocate oldURL newURL' |
| doExport() | 'svn export' |
- Since:
- 1.2
- Version:
- 1.3
- Author:
- TMate Software Ltd.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionSVNUpdateClient(ISVNAuthenticationManager authManager, ISVNOptions options) Constructs and initializes an SVNUpdateClient object with the specified run-time configuration and authentication drivers.SVNUpdateClient(ISVNRepositoryPool repositoryPool, ISVNOptions options) Constructs and initializes an SVNUpdateClient object with the specified run-time configuration and authentication drivers. -
Method Summary
Modifier and TypeMethodDescriptionvoiddoCanonicalizeURLs(File dst, boolean omitDefaultPort, boolean recursive) Canonicalizes all urls in the specified Working Copy.longdoCheckout(SVNURL url, File dstPath, SVNRevision pegRevision, SVNRevision revision, boolean recursive) Deprecated.longdoCheckout(SVNURL url, File dstPath, SVNRevision pegRevision, SVNRevision revision, boolean recursive, boolean force) Deprecated.longdoCheckout(SVNURL url, File dstPath, SVNRevision pegRevision, SVNRevision revision, SVNDepth depth, boolean allowUnversionedObstructions) Checks out a working copy ofurlatrevision, looked up atpegRevision, usingdstPathas the root directory of the newly checked out working copy.longdoExport(File srcPath, File dstPath, SVNRevision pegRevision, SVNRevision revision, String eolStyle, boolean force, boolean recursive) longdoExport(File srcPath, File dstPath, SVNRevision pegRevision, SVNRevision revision, String eolStyle, boolean overwrite, SVNDepth depth) Exports the contents of either a subversion repository or a subversion working copy into a 'clean' directory (meaning a directory with no administrative directories).longdoExport(SVNURL url, File dstPath, SVNRevision pegRevision, SVNRevision revision, String eolStyle, boolean force, boolean recursive) longdoExport(SVNURL url, File dstPath, SVNRevision pegRevision, SVNRevision revision, String eolStyle, boolean overwrite, SVNDepth depth) Exports the contents of a subversion repository into a 'clean' directory (meaning a directory with no administrative directories).voiddoRelocate(File dst, SVNURL oldURL, SVNURL newURL, boolean recursive) Substitutes the beginning part of a Working Copy's URL with a new one.longdoSwitch(File file, SVNURL url, SVNRevision revision, boolean recursive) Deprecated.longdoSwitch(File file, SVNURL url, SVNRevision pegRevision, SVNRevision revision, boolean recursive) Deprecated.longdoSwitch(File file, SVNURL url, SVNRevision pegRevision, SVNRevision revision, boolean recursive, boolean force) Deprecated.longdoSwitch(File path, SVNURL url, SVNRevision pegRevision, SVNRevision revision, SVNDepth depth, boolean allowUnversionedObstructions, boolean depthIsSticky) Switches working treepathtourl\pegRevisionatrevision.longdoSwitch(File path, SVNURL url, SVNRevision pegRevision, SVNRevision revision, SVNDepth depth, boolean allowUnversionedObstructions, boolean depthIsSticky, boolean ignoreAncestry) long[]doUpdate(File[] paths, SVNRevision revision, SVNDepth depth, boolean allowUnversionedObstructions, boolean depthIsSticky) Updates working treespathstorevision.long[]doUpdate(File[] paths, SVNRevision revision, SVNDepth depth, boolean allowUnversionedObstructions, boolean depthIsSticky, boolean makeParents) longdoUpdate(File file, SVNRevision revision, boolean recursive) Deprecated.longdoUpdate(File file, SVNRevision revision, boolean recursive, boolean force) Deprecated.longdoUpdate(File path, SVNRevision revision, SVNDepth depth, boolean allowUnversionedObstructions, boolean depthIsSticky) Updates working copytorevision.Returns an externals handler used by this update client.protected voidbooleanSays whether keywords expansion during export operations is turned on or not.booleanSays whether the entire working copy should be locked while updating or not.voidsetExportExpandsKeywords(boolean expand) Sets whether keywords must be expanded during an export operation.voidsetExternalsHandler(ISVNExternalsHandler externalsHandler) Sets an externals handler to be used by this client object.voidsetUpdateLocksOnDemand(boolean locksOnDemand) Sets whether working copies should be locked on demand or not during an update process.Methods inherited from class org.tmatesoft.svn.core.wc.SVNBasicClient
dontWC17Support, getDebugLog, getOperationsFactory, getOptions, getPathListHandler, getReposRoot, getReposRoot, isIgnoreExternals, isLeaveConflictsUnresolved, isWC17Supported, setDebugLog, setEventHandler, setEventPathPrefix, setIgnoreExternals, setLeaveConflictsUnresolved, setOptions, setPathListHandler
-
Constructor Details
-
SVNUpdateClient
Constructs and initializes an SVNUpdateClient object with the specified run-time configuration and authentication drivers.If
optionsis null, then this SVNUpdateClient 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 onISVNOptionsandSVNWCUtil).If
authManageris null, then this SVNUpdateClient will be using a default authentication and network layers driver (seeSVNWCUtil.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 driveroptions- a run-time configuration options driver
-
SVNUpdateClient
Constructs and initializes an SVNUpdateClient object with the specified run-time configuration and authentication drivers. Ifoptionsis null, then this SVNUpdateClient 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 onISVNOptionsandSVNWCUtil). IfrepositoryPoolis null, thenSVNRepositoryFactorywill be used to createrepository access objects.- Parameters:
repositoryPool- a repository pool objectoptions- a run-time configuration options driver
-
SVNUpdateClient
-
-
Method Details
-
initDefaults
protected void initDefaults()- Overrides:
initDefaultsin classSVNBasicClient
-
setExternalsHandler
Sets an externals handler to be used by this client object.- Parameters:
externalsHandler- user's implementation ofISVNExternalsHandler- Since:
- 1.2
- See Also:
-
getExternalsHandler
Returns an externals handler used by this update client. If no user's handler is provided thenISVNExternalsHandler.DEFAULTis returned and used by this client object by default. For more information what externals handlers are for, please, refer toISVNExternalsHandler.- Returns:
- externals handler being in use
- Since:
- 1.2
- See Also:
-
doUpdate
Deprecated.Brings the Working Copy item up-to-date with repository changes at the specified revision.As a revision SVNRevision's pre-defined constant fields can be used. For example, to update the Working Copy to the latest revision of the repository use
HEAD.- Parameters:
file- the Working copy item to be updatedrevision- the desired revision against which the item will be updatedrecursive- if true andfileis a directory then the entire tree will be updated, otherwise if false - only items located immediately in the directory itself- Returns:
- the revision number to which
filewas updated to - Throws:
SVNException
-
doUpdate
public long doUpdate(File file, SVNRevision revision, boolean recursive, boolean force) throws SVNException Deprecated.- Parameters:
file-revision-recursive-force-- Returns:
- actual revision number
- Throws:
SVNException
-
doUpdate
public long[] doUpdate(File[] paths, SVNRevision revision, SVNDepth depth, boolean allowUnversionedObstructions, boolean depthIsSticky) throws SVNException Updates working treespathstorevision. Unversioned paths that are direct children of a versioned path will cause an update that attempts to add that path, other unversioned paths are skipped.revisionmust represent a valid revision number (SVNRevision.getNumber()>= 0), or date (SVNRevision.getDate()!= true), or be equal toSVNRevision.HEAD. Ifrevisiondoes not meet these requirements, an exception with the error codeSVNErrorCode.CLIENT_BAD_REVISIONis thrown. The paths inpathscan be from multiple working copies from multiple repositories, but even if they all come from the same repository there is no guarantee that revision represented bySVNRevision.HEADwill remain the same as each path is updated. If externals areignored, doesn't process externals definitions as part of this operation. IfdepthisSVNDepth.INFINITY, updates fully recursively. Else if it isSVNDepth.IMMEDIATESorSVNDepth.FILES, updates each target and its file entries, but not its subdirectories. Else ifSVNDepth.EMPTY, updates exactly each target, nonrecursively (essentially, updates the target's properties). IfdepthisSVNDepth.UNKNOWN, takes the working depth frompathsand then behaves as described above. IfdepthIsStickyis set anddepthis notSVNDepth.UNKNOWN, then in addition to updatingpaths, also sets their sticky ambient depth value todepth. IfallowUnversionedObstructionsis true then the update tolerates existing unversioned items that obstruct added paths. Only obstructions of the same type (file or dir) as the added item are tolerated. The text of obstructing files is left as-is, effectively treating it as a user modification after the update. Working properties of obstructing items are set equal to the base properties. IfallowUnversionedObstructionsis false then the update will abort if there are any unversioned obstructing items. If the caller'sISVNEventHandleris non-null, it is invoked for each item handled by the update, and also for files restored from text-base. AlsoISVNCanceller.checkCancelled()will be used at various places during the update to check whether the caller wants to stop the update. This operation requires repository access (in case the repository is not on the same machine, network connection is established).- Parameters:
paths- working copy pathsrevision- revision to update todepth- tree depth to updateallowUnversionedObstructions- flag that allows tolerating unversioned items during updatedepthIsSticky- flag that controls whether the requested depth should be written to the working copy- Returns:
- an array of
longrevisions with each element set to the revision to whichrevisionwas resolved - Throws:
SVNException- Since:
- 1.2, SVN 1.5
-
doUpdate
public long[] doUpdate(File[] paths, SVNRevision revision, SVNDepth depth, boolean allowUnversionedObstructions, boolean depthIsSticky, boolean makeParents) throws SVNException - Throws:
SVNException
-
doUpdate
public long doUpdate(File path, SVNRevision revision, SVNDepth depth, boolean allowUnversionedObstructions, boolean depthIsSticky) throws SVNException Updates working copytorevision. Unversioned paths that are direct children of a versioned path will cause an update that attempts to add that path, other unversioned paths are skipped.revisionmust represent a valid revision number (SVNRevision.getNumber()>= 0), or date (SVNRevision.getDate()!= true), or be equal toSVNRevision.HEAD. Ifrevisiondoes not meet these requirements, an exception with the error codeSVNErrorCode.CLIENT_BAD_REVISIONis thrown. If externals areignored, doesn't process externals definitions as part of this operation. IfdepthisSVNDepth.INFINITY, updates fully recursively. Else if it isSVNDepth.IMMEDIATESorSVNDepth.FILES, updatespathand its file entries, but not its subdirectories. Else ifSVNDepth.EMPTY, updates exactlypath, nonrecursively (essentially, updates the target's properties). IfdepthisSVNDepth.UNKNOWN, takes the working depth frompathand then behaves as described above. IfdepthIsStickyis set anddepthis notSVNDepth.UNKNOWN, then in addition to updatingpath, also sets its sticky ambient depth value todepth. IfallowUnversionedObstructionsis true then the update tolerates existing unversioned items that obstruct added paths. Only obstructions of the same type (file or dir) as the added item are tolerated. The text of obstructing files is left as-is, effectively treating it as a user modification after the update. Working properties of obstructing items are set equal to the base properties. IfallowUnversionedObstructionsis false then the update will abort if there are any unversioned obstructing items. If the caller'sISVNEventHandleris non-null, it is invoked for each item handled by the update, and also for files restored from text-base. AlsoISVNCanceller.checkCancelled()will be used at various places during the update to check whether the caller wants to stop the update. This operation requires repository access (in case the repository is not on the same machine, network connection is established).- Parameters:
path- working copy pathrevision- revision to update todepth- tree depth to updateallowUnversionedObstructions- flag that allows tollerating unversioned items during updatedepthIsSticky- flag that controls whether the requested depth should be written to the working copy- Returns:
- revision to which
revisionwas resolved - Throws:
SVNException- Since:
- 1.2, SVN 1.5
-
setUpdateLocksOnDemand
public void setUpdateLocksOnDemand(boolean locksOnDemand) Sets whether working copies should be locked on demand or not during an update process.For additional description, please, refer to
isUpdateLocksOnDemand().- Parameters:
locksOnDemand- true to make update lock a working copy tree on demand only (for those subdirectories only which will be changed by update)
-
isUpdateLocksOnDemand
public boolean isUpdateLocksOnDemand()Says whether the entire working copy should be locked while updating or not. If this method returns false, then the working copy will be closed for all paths involved in the update. Otherwise only those working copy subdirectories will be locked, which will be either changed by the update or which contain deleted files that should be restored during the update; all other versioned subdirectories than won't be touched by the update will remain opened for read only access without locking. Locking working copies on demand is intended to improve update performance for large working copies because even a no-op update on a huge working copy always locks the entire tree by default. And locking a working copy tree means opening special lock files for privileged access for all subdirectories involved. This makes an update process work slower. Locking wc on demand feature suggests such a workaround to enhance update performance.- Returns:
- true when locking wc on demand
-
doSwitch
public long doSwitch(File file, SVNURL url, SVNRevision revision, boolean recursive) throws SVNException Deprecated.Updates the Working Copy item to mirror a new URL.As a revision SVNRevision's pre-defined constant fields can be used. For example, to update the Working Copy to the latest revision of the repository use
HEAD.Calling this method is equivalent to
doSwitch(file, url, SVNRevision.UNDEFINED, revision, recursive).- Parameters:
file- the Working copy item to be switchedurl- the repository location as a target against which the item will be switchedrevision- the desired revision of the repository targetrecursive- if true andfileis a directory then the entire tree will be updated, otherwise if false - only items located immediately in the directory itself- Returns:
- the revision number to which
filewas updated to - Throws:
SVNException
-
doSwitch
public long doSwitch(File file, SVNURL url, SVNRevision pegRevision, SVNRevision revision, boolean recursive) throws SVNException Deprecated.Updates the Working Copy item to mirror a new URL.As a revision SVNRevision's pre-defined constant fields can be used. For example, to update the Working Copy to the latest revision of the repository use
HEAD.- Parameters:
file- the Working copy item to be switchedurl- the repository location as a target against which the item will be switchedpegRevision- a revision in whichfileis first looked up in the repositoryrevision- the desired revision of the repository targetrecursive- if true andfileis a directory then the entire tree will be updated, otherwise if false - only items located immediately in the directory itself- Returns:
- the revision number to which
filewas updated to - Throws:
SVNException
-
doSwitch
public long doSwitch(File file, SVNURL url, SVNRevision pegRevision, SVNRevision revision, boolean recursive, boolean force) throws SVNException Deprecated.- Parameters:
file-url-pegRevision-revision-recursive-force-- Returns:
- actual revision number
- Throws:
SVNException
-
doSwitch
public long doSwitch(File path, SVNURL url, SVNRevision pegRevision, SVNRevision revision, SVNDepth depth, boolean allowUnversionedObstructions, boolean depthIsSticky) throws SVNException Switches working treepathtourl\pegRevisionatrevision. Summary of purpose: this is normally used to switch a working directory over to another line of development, such as a branch or a tag. Switching an existing working directory is more efficient than checking outurlfrom scratch.revisionmust represent a valid revision number (SVNRevision.getNumber()>= 0), or date (SVNRevision.getDate()!= true), or be equal toSVNRevision.HEAD. Ifrevisiondoes not meet these requirements, an exception with the error codeSVNErrorCode.CLIENT_BAD_REVISIONis thrown. IfdepthisSVNDepth.INFINITY, switches fully recursively. Else if it isSVNDepth.IMMEDIATES, switchespathand its file children (if any), and switches subdirectories but does not update them. Else ifSVNDepth.FILES, switches just file children, ignoring subdirectories completely. Else ifSVNDepth.EMPTY, switches justpathand touches nothing underneath it. IfdepthIsStickyis set anddepthis notSVNDepth.UNKNOWN, then in addition to switchingpath, also sets its sticky ambient depth value todepth. If externals areignored, doesn't process externals definitions as part of this operation. IfallowUnversionedObstructionsis true then the switch tolerates existing unversioned items that obstruct added paths. Only obstructions of the same type (file or dir) as the added item are tolerated. The text of obstructing files is left as-is, effectively treating it as a user modification after the switch. Working properties of obstructing items are set equal to the base properties. IfallowUnversionedObstructionsis false then the switch will abort if there are any unversioned obstructing items. If the caller'sISVNEventHandleris non-null, it is invoked for paths affected by the switch, and also for files restored from text-base. AlsoISVNCanceller.checkCancelled()will be used at various places during the switch to check whether the caller wants to stop the switch. This operation requires repository access (in case the repository is not on the same machine, network connection is established).- Parameters:
path- the Working copy item to be switchedurl- the repository location as a target against which the item will be switchedpegRevision- a revision in whichpathis first looked up in the repositoryrevision- the desired revision of the repository targetdepth- tree depth to updateallowUnversionedObstructions- flag that allows tollerating unversioned items during updatedepthIsSticky- flag that controls whether the requested depth should be written into the working copy- Returns:
- value of the revision to which the working copy was actually switched
- Throws:
SVNException- Since:
- 1.2, SVN 1.5
-
doSwitch
public long doSwitch(File path, SVNURL url, SVNRevision pegRevision, SVNRevision revision, SVNDepth depth, boolean allowUnversionedObstructions, boolean depthIsSticky, boolean ignoreAncestry) throws SVNException - Throws:
SVNException
-
doCheckout
public long doCheckout(SVNURL url, File dstPath, SVNRevision pegRevision, SVNRevision revision, boolean recursive) throws SVNException Deprecated.Checks out a Working Copy from a repository.If the destination path (
dstPath) is null then the last component ofurlis used for the local directory name.As a revision SVNRevision's pre-defined constant fields can be used. For example, to check out a Working Copy at the latest revision of the repository use
HEAD.- Parameters:
url- a repository location from where a Working Copy will be checked outdstPath- the local path where the Working Copy will be placedpegRevision- the revision at whichurlwill be firstly seen in the repository to make sure it's the one that is neededrevision- the desired revision of the Working Copy to be checked outrecursive- if true andurlis a directory then the entire tree will be checked out, otherwise if false - only items located immediately in the directory itself- Returns:
- the revision number of the Working Copy
- Throws:
SVNException-urlrefers to a file, not a directory;dstPathalready exists but it is a file, not a directory;dstPathalready exists and is a versioned directory but has a different URL (repository location against which the directory is controlled)
-
doCheckout
public long doCheckout(SVNURL url, File dstPath, SVNRevision pegRevision, SVNRevision revision, boolean recursive, boolean force) throws SVNException Deprecated.- Parameters:
url-dstPath-pegRevision-revision-recursive-force-- Returns:
- actual revision number
- Throws:
SVNException
-
doCheckout
public long doCheckout(SVNURL url, File dstPath, SVNRevision pegRevision, SVNRevision revision, SVNDepth depth, boolean allowUnversionedObstructions) throws SVNException Checks out a working copy ofurlatrevision, looked up atpegRevision, usingdstPathas the root directory of the newly checked out working copy. IfpegRevisionisSVNRevision.UNDEFINED, then it defaults toSVNRevision.HEAD.revisionmust represent a valid revision number (SVNRevision.getNumber()>= 0), or date (SVNRevision.getDate()!= true), or be equal toSVNRevision.HEAD. Ifrevisiondoes not meet these requirements, an exception with the error codeSVNErrorCode.CLIENT_BAD_REVISIONis thrown. IfdepthisSVNDepth.INFINITY, checks out fully recursively. Else if it isSVNDepth.IMMEDIATES, checks outurland its immediate entries (subdirectories will be present, but will be at depthSVNDepth.EMPTYthemselves); elseSVNDepth.FILES, checks outurland its file entries, but no subdirectories; else ifSVNDepth.EMPTY, checks outurlas an empty directory at that depth, with no entries present. IfdepthisSVNDepth.UNKNOWN, then behave as if forSVNDepth.INFINITY, except in the case of resuming a previous checkout ofdstPath(i.e., updating), in which case uses the depth of the existing working copy. If externals areignored, doesn't process externals definitions as part of this operation. IfallowUnversionedObstructionsis true then the checkout tolerates existing unversioned items that obstruct added paths fromurl. Only obstructions of the same type (file or dir) as the added item are tolerated. The text of obstructing files is left as-is, effectively treating it as a user modification after the checkout. Working properties of obstructing items are set equal to the base properties. IfallowUnversionedObstructionsis false then the checkout will abort if there are any unversioned obstructing items. If the caller'sISVNEventHandleris non-null, it is invoked as the checkout processes. AlsoISVNCanceller.checkCancelled()will be used at various places during the checkout to check whether the caller wants to stop the checkout. This operation requires repository access (in case the repository is not on the same machine, network connection is established).- Parameters:
url- a repository location from where a Working Copy will be checked outdstPath- the local path where the Working Copy will be placedpegRevision- the revision at whichurlwill be firstly seen in the repository to make sure it's the one that is neededrevision- the desired revision of the Working Copy to be checked outdepth- tree depthallowUnversionedObstructions- flag that allows tollerating unversioned items during- Returns:
- value of the revision actually checked out from the repository
- Throws:
SVNException-SVNErrorCode.UNSUPPORTED_FEATURE- ifurlrefers to a file rather than a directorySVNErrorCode.RA_ILLEGAL_URL- ifurldoes not exist- Since:
- 1.2, SVN 1.5
-
doExport
public long doExport(SVNURL url, File dstPath, SVNRevision pegRevision, SVNRevision revision, String eolStyle, boolean force, boolean recursive) throws SVNException Exports a clean directory or single file from a repository.If
eolStyleis not null then it should denote a specific End-Of-Line marker for the files to be exported. Significant values foreolStyleare:- "CRLF" (Carriage Return Line Feed) - this causes files to contain '\r\n' line ending sequences for EOL markers, regardless of the operating system in use (for instance, this EOL marker is used by software on the Windows platform).
- "LF" (Line Feed) - this causes files to contain '\n' line ending sequences for EOL markers, regardless of the operating system in use (for instance, this EOL marker is used by software on the Unix platform).
- "CR" (Carriage Return) - this causes files to contain '\r' line ending sequences for EOL markers, regardless of the operating system in use (for instance, this EOL marker was used by software on older Macintosh platforms).
- "native" - this causes files to contain the EOL markers that are native to the operating system on which SVNKit is run.
- Parameters:
url- a repository location from where the unversioned directory/file will be exporteddstPath- the local path where the repository items will be exported topegRevision- the revision at whichurlwill be firstly seen in the repository to make sure it's the one that is neededrevision- the desired revision of the directory/file to be exportedeolStyle- a string that denotes a specific End-Of-Line charecter;force- true to fore the operation even if there are local files with the same names as those in the repository (local ones will be replaced)recursive- if true andurlis a directory then the entire tree will be exported, otherwise if false - only items located immediately in the directory itself- Returns:
- the revision number of the exported directory/file
- Throws:
SVNException
-
doExport
public long doExport(SVNURL url, File dstPath, SVNRevision pegRevision, SVNRevision revision, String eolStyle, boolean overwrite, SVNDepth depth) throws SVNException Exports the contents of a subversion repository into a 'clean' directory (meaning a directory with no administrative directories).pegRevisionis the revision where the path is first looked up. IfpegRevisionisSVNRevision.UNDEFINED, then it defaults toSVNRevision.HEAD. If externals areignored, doesn't process externals definitions as part of this operation.eolStyleallows you to override the standard eol marker on the platform you are running on. Can be either "LF", "CR" or "CRLF" or null. If null will use the standard eol marker. Any other value will cause an exception with the error codeSVNErrorCode.IO_UNKNOWN_EOLerror to be returned.If
depthisSVNDepth.INFINITY, exports fully recursively. Else if it isSVNDepth.IMMEDIATES, exportsurland its immediate children (if any), but with subdirectories empty and atSVNDepth.EMPTY. Else ifSVNDepth.FILES, exportsurland its immediate file children (if any) only. IfdepthisSVNDepth.EMPTY, then exports exactlyurland none of its children.- Parameters:
url- repository url to export fromdstPath- path to export topegRevision- the revision at whichurlwill be firstly seen in the repository to make sure it's the one that is neededrevision- the desired revision of the directory/file to be exportedeolStyle- a string that denotes a specific End-Of-Line charecteroverwrite- if true, will cause the export to overwrite files or directoriesdepth- tree depth- Returns:
- value of the revision actually exported
- Throws:
SVNException- Since:
- 1.2, SVN 1.5
-
doExport
public long doExport(File srcPath, File dstPath, SVNRevision pegRevision, SVNRevision revision, String eolStyle, boolean force, boolean recursive) throws SVNException Exports a clean directory or single file from eihter a source Working Copy or a repository.How this method works:
- If
revisionis different fromBASE,WORKING,COMMITTED,UNDEFINED- then the repository origin ofsrcPathwill be exported (what is done by "remote"doExport()). - In other cases a clean unversioned copy of
srcPath- either a directory or a single file - is exported todstPath.
If
eolStyleis not null then it should denote a specific End-Of-Line marker for the files to be exported. Significant values foreolStyleare:- "CRLF" (Carriage Return Line Feed) - this causes files to contain '\r\n' line ending sequences for EOL markers, regardless of the operating system in use (for instance, this EOL marker is used by software on the Windows platform).
- "LF" (Line Feed) - this causes files to contain '\n' line ending sequences for EOL markers, regardless of the operating system in use (for instance, this EOL marker is used by software on the Unix platform).
- "CR" (Carriage Return) - this causes files to contain '\r' line ending sequences for EOL markers, regardless of the operating system in use (for instance, this EOL marker was used by software on older Macintosh platforms).
- "native" - this causes files to contain the EOL markers that are native to the operating system on which SVNKit is run.
- Parameters:
srcPath- a repository location from where the unversioned directory/file will be exporteddstPath- the local path where the repository items will be exported topegRevision- the revision at whichurlwill be firstly seen in the repository to make sure it's the one that is neededrevision- the desired revision of the directory/file to be exportedeolStyle- a string that denotes a specific End-Of-Line charecter;force- true to fore the operation even if there are local files with the same names as those in the repository (local ones will be replaced)recursive- if true andurlis a directory then the entire tree will be exported, otherwise if false - only items located immediately in the directory itself- Returns:
- the revision number of the exported directory/file
- Throws:
SVNException
- If
-
doExport
public long doExport(File srcPath, File dstPath, SVNRevision pegRevision, SVNRevision revision, String eolStyle, boolean overwrite, SVNDepth depth) throws SVNException Exports the contents of either a subversion repository or a subversion working copy into a 'clean' directory (meaning a directory with no administrative directories).pegRevisionis the revision where the path is first looked up when exporting from a repository. IfpegRevisionisSVNRevision.UNDEFINED, then it defaults toSVNRevision.WORKING. Ifrevisionis one of: then local export is performed. Otherwise exporting from the repository. If externals areignored, doesn't process externals definitions as part of this operation.eolStyleallows you to override the standard eol marker on the platform you are running on. Can be either "LF", "CR" or "CRLF" or null. If null will use the standard eol marker. Any other value will cause an exception with the error codeSVNErrorCode.IO_UNKNOWN_EOLerror to be returned.If
depthisSVNDepth.INFINITY, exports fully recursively. Else if it isSVNDepth.IMMEDIATES, exportssrcPathand its immediate children (if any), but with subdirectories empty and atSVNDepth.EMPTY. Else ifSVNDepth.FILES, exportssrcPathand its immediate file children (if any) only. IfdepthisSVNDepth.EMPTY, then exports exactlysrcPathand none of its children.- Parameters:
srcPath- working copy pathdstPath- path to export topegRevision- the revision at whichurlwill be firstly seen in the repository to make sure it's the one that is neededrevision- the desired revision of the directory/file to be exported; used only when exporting from a repositoryeolStyle- a string that denotes a specific End-Of-Line charecteroverwrite- if true, will cause the export to overwrite files or directoriesdepth- tree depth- Returns:
- value of the revision actually exported
- Throws:
SVNException- Since:
- 1.2, SVN 1.5
-
doRelocate
public void doRelocate(File dst, SVNURL oldURL, SVNURL newURL, boolean recursive) throws SVNException Substitutes the beginning part of a Working Copy's URL with a new one.When a repository root location or a URL schema is changed the old URL of the Working Copy which starts with
oldURLshould be substituted for a new URL beginning -newURL.- Parameters:
dst- a Working Copy item's patholdURL- the old beginning part of the repository's URL that should be overwrittennewURL- a new beginning part for the repository location that will overwriteoldURLrecursive- if true anddstis a directory then the entire tree will be relocated, otherwise if false - onlydstitself- Throws:
SVNException
-
doCanonicalizeURLs
public void doCanonicalizeURLs(File dst, boolean omitDefaultPort, boolean recursive) throws SVNException Canonicalizes all urls in the specified Working Copy.- Parameters:
dst- a WC pathomitDefaultPort- if true then removes all port numbers from urls which equal to default ones, otherwise does notrecursive- recurses an operation- Throws:
SVNException
-
setExportExpandsKeywords
public void setExportExpandsKeywords(boolean expand) Sets whether keywords must be expanded during an export operation.- Parameters:
expand- true to expand; otherwise false- Since:
- 1.3
-
isExportExpandsKeywords
public boolean isExportExpandsKeywords()Says whether keywords expansion during export operations is turned on or not.- Returns:
- true if expanding keywords; false otherwise
- Since:
- 1.3
-
doCheckout(SVNURL, File, SVNRevision, SVNRevision, SVNDepth, boolean)instead