Package org.tmatesoft.svn.core.wc2
Class SvnExport
- java.lang.Object
-
- org.tmatesoft.svn.core.wc2.SvnOperation<V>
-
- org.tmatesoft.svn.core.wc2.AbstractSvnUpdate<java.lang.Long>
-
- org.tmatesoft.svn.core.wc2.SvnExport
-
- All Implemented Interfaces:
ISvnOperationOptionsProvider
public class SvnExport extends AbstractSvnUpdate<java.lang.Long>
Represents export operation. Exports the contents of either a subversion repository or a subversion working copy (source
) into atarget
- 'clean' directory (meaning a directory with no administrative directories).source
'spegRevision
is the revision where the path is first looked up when exporting from a repository. Ifsource
'spegRevision
isSVNRevision.UNDEFINED
, then it defaults toSVNRevision.WORKING
. Ifrevision
is one of: then local export is performed. Otherwise exporting from the repository. Ifrevision
isSVNRevision.UNDEFINED
it defaults toSVNRevision.WORKING
. If externals are ignored (ignoreExternals
istrue
), doesn't process externals definitions as part of this operation.eolStyle
allows you to override the standard eol marker on the platform you are running on. Can be either "LF", "CR" or "CRLF" ornull
. Ifnull
will use the standard eol marker. Any other value will cause an exception with the error codeSVNErrorCode.IO_UNKNOWN_EOL
error to be returned.If
depth
isSVNDepth.INFINITY
, exports fully recursively. Else if it isSVNDepth.IMMEDIATES
, exportssource
and its immediate children (if any), but with subdirectories empty and atSVNDepth.EMPTY
. Else ifSVNDepth.FILES
, exportssource
and its immediate file children (if any) only. Ifdepth
isSVNDepth.EMPTY
, then exports exactlysource
and none of its children.SvnOperation.run()
method returns value of the revision actually exported.SvnOperation.run()
throwsSVNException
in the following cases:-
exception with
SVNErrorCode.IO_ERROR
error code - iftarget
's directory already exists andforce
isfalse
exception withSVNErrorCode.ILLEGAL_TARGET
error code - if destination file already exists andforce
isfalse
, or if destination directory exists and should be overridden by source file- Version:
- 1.7
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
eolStyle
private boolean
expandKeywords
private boolean
force
private SvnTarget
source
-
Constructor Summary
Constructors Modifier Constructor Description protected
SvnExport(SvnOperationFactory factory)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
ensureArgumentsAreValid()
java.lang.String
getEolStyle()
Returns the string that denotes a specific End-Of-Line character.protected java.io.File
getOperationalWorkingCopy()
SvnTarget
getSource()
Returns export's source - working copy path or repository URL.protected void
initDefaults()
boolean
isChangesWorkingCopy()
Gets whether the operation changes working copyboolean
isExpandKeywords()
Gets whether or not all keywords presenting in the file and listed in the file'sSVNProperty.KEYWORDS
property (if set) should be substituted.boolean
isForce()
Gets whether to overwrite files or directories.void
setEolStyle(java.lang.String eolStyle)
Sets the string that denotes a specific End-Of-Line character.void
setExpandKeywords(boolean expandKeywords)
Sets whether or not all keywords presenting in the file and listed in the file'sSVNProperty.KEYWORDS
property (if set) should be substituted.void
setForce(boolean force)
Sets whether to overwrite files or directories.void
setSource(SvnTarget source)
Sets export's source - working copy path or repository URL.-
Methods inherited from class org.tmatesoft.svn.core.wc2.AbstractSvnUpdate
getExternalsHandler, isAllowUnversionedObstructions, isIgnoreExternals, isUpdateLocksOnDemand, setAllowUnversionedObstructions, setExternalsHandler, setIgnoreExternals, setUpdateLocksOnDemand
-
Methods inherited from class org.tmatesoft.svn.core.wc2.SvnOperation
addTarget, cancel, ensureEnoughTargets, ensureHomohenousTargets, getApplicableChangelists, getAuthenticationManager, getCanceller, getDepth, getEventHandler, getFirstTarget, getMaximumTargetsCount, getMinimumTargetsCount, getOperationFactory, getOptions, getRepositoryPool, getRevision, getSqliteJournalMode, getTargets, hasFileTargets, hasLocalTargets, hasRemoteTargets, isCancelled, isSleepForTimestamp, isUseParentWcFormat, needsHomohenousTargets, run, setApplicalbeChangelists, setDepth, setRevision, setSingleTarget, setSleepForTimestamp, setSqliteJournalMode
-
-
-
-
Field Detail
-
force
private boolean force
-
expandKeywords
private boolean expandKeywords
-
eolStyle
private java.lang.String eolStyle
-
source
private SvnTarget source
-
-
Constructor Detail
-
SvnExport
protected SvnExport(SvnOperationFactory factory)
-
-
Method Detail
-
isForce
public boolean isForce()
Gets whether to overwrite files or directories.- Returns:
true
if export should overwrite files or directories, otherwisefalse
-
isExpandKeywords
public boolean isExpandKeywords()
Gets whether or not all keywords presenting in the file and listed in the file'sSVNProperty.KEYWORDS
property (if set) should be substituted.- Returns:
true
if keywords should expanded, otherwisefalse
- Since:
- 1.7, SVN 1.7
-
getEolStyle
public java.lang.String getEolStyle()
Returns the string that denotes a specific End-Of-Line character.- Returns:
- specific End-Of-Line character of the operation
- See Also:
setEolStyle(String)
-
setForce
public void setForce(boolean force)
Sets whether to overwrite files or directories.- Parameters:
force
-true
if export should overwrite files or directories, otherwisefalse
-
setExpandKeywords
public void setExpandKeywords(boolean expandKeywords)
Sets whether or not all keywords presenting in the file and listed in the file'sSVNProperty.KEYWORDS
property (if set) should be substituted.- Parameters:
expandKeywords
-true
if keywords should expanded, otherwisefalse
- Since:
- 1.7, SVN 1.7
-
setEolStyle
public void setEolStyle(java.lang.String eolStyle)
Sets the string that denotes a specific End-Of-Line character.eolStyle
allows you to override the standard eol marker on the platform you are running on. Can be either "LF", "CR" or "CRLF" ornull
. Ifnull
will use the standard eol marker. Any other value will cause an exception with the error codeSVNErrorCode.IO_UNKNOWN_EOL
error to be returned.- Parameters:
eolStyle
- specific End-Of-Line character of the operation
-
getSource
public SvnTarget getSource()
Returns export's source - working copy path or repository URL.- Returns:
- source of the export
-
setSource
public void setSource(SvnTarget source)
Sets export's source - working copy path or repository URL.- Parameters:
source
- source of the export
-
ensureArgumentsAreValid
protected void ensureArgumentsAreValid() throws SVNException
- Overrides:
ensureArgumentsAreValid
in classSvnOperation<java.lang.Long>
- Throws:
SVNException
-
initDefaults
protected void initDefaults()
- Overrides:
initDefaults
in classSvnOperation<java.lang.Long>
-
getOperationalWorkingCopy
protected java.io.File getOperationalWorkingCopy()
- Overrides:
getOperationalWorkingCopy
in classSvnOperation<java.lang.Long>
-
isChangesWorkingCopy
public boolean isChangesWorkingCopy()
Gets whether the operation changes working copy- Overrides:
isChangesWorkingCopy
in classSvnOperation<java.lang.Long>
- Returns:
true
if the operation changes the working copy, otherwisefalse
-
-