SVNCommandEnvironment (Parent POM 1 API)

java.lang.Object
- org.tmatesoft.svn.cli.AbstractSVNCommandEnvironment
- - org.tmatesoft.svn.cli.svn.SVNCommandEnvironment

All Implemented Interfaces:: ISVNCanceller, ISVNCommitHandler

public class SVNCommandEnvironment
extends AbstractSVNCommandEnvironment
implements ISVNCommitHandler

Version:: 1.3
Author:: TMate Software Ltd.

Field Summary
- Fields inherited from interface org.tmatesoft.svn.core.ISVNCanceller
  NULL

Constructor Summary

Constructors
Constructor and Description
`SVNCommandEnvironment(String programName, PrintStream out, PrintStream err, InputStream in)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected ISVNAuthenticationManager`	`createClientAuthenticationManager()`
`protected DefaultSVNOptions`	`createClientOptions()`
`String`	`getAuthorOfInterest()`
`String`	`getChangelist()`
`String[]`	`getChangelists()`
`Collection`	`getChangelistsCollection()`
`protected String`	`getCommandLineClientName()`
`String`	`getCommitMessage(String message, SVNCommitItem[] commitables)` Handles the incoming initial log message and items intended for a commit and returns a new commit log message.
`SVNConflictStats`	`getConflictStats()`
`SVNDepth`	`getDepth()`
`String`	`getDiffCommand()`
`SVNDiffOptions`	`getDiffOptions()`
`String`	`getEditorCommand()`
`String`	`getEncoding()`
`SVNRevision`	`getEndRevision()`
`Collection`	`getExtensions()`
`byte[]`	`getFileData()`
`long`	`getLimit()`
`String`	`getMessage()`
`String`	`getNativeEOL()`
`String`	`getNewTarget()`
`String`	`getOldTarget()`
`String`	`getRegularExpression()`
`SVNConflictAcceptPolicy`	`getResolveAccept()`
`SVNProperties`	`getRevisionProperties()`
`SVNProperties`	`getRevisionProperties(String message, SVNCommitItem[] commitables, SVNProperties revisionProperties)` Handles the incoming revision properties and returns filtered revision properties given the paths (represented by `commitables`) collected for committing and the commit log message.
`List`	`getRevisionRanges()`
`SVNDepth`	`getSetDepth()`
`String`	`getShowItem()`
`SVNShowRevisionType`	`getShowRevisionType()`
`SVNRevision`	`getStartRevision()`
`int`	`getStripCount()`
`protected SVNCommand`	`getSVNCommand()`
`List`	`getTargets()`
`void`	`initClientManager()`
`protected void`	`initOption(SVNOptionValue optionValue)`
`protected void`	`initOptions(SVNCommandLine commandLine)`
`boolean`	`isAllowMixedRevisions()`
`boolean`	`isAllRevisionProperties()`
`boolean`	`isChangeOptionUsed()`
`boolean`	`isDryRun()`
`boolean`	`isForce()`
`boolean`	`isForceLog()`
`boolean`	`isGitDiffFormat()`
`boolean`	`isIgnoreAncestry()`
`boolean`	`isIgnoreKeywords()`
`boolean`	`isIgnoreProperties()`
`boolean`	`isIgnoreWhitespace()`
`boolean`	`isIncludeExternals()`
`boolean`	`isIncremental()`
`boolean`	`isKeepChangelist()`
`boolean`	`isKeepLocal()`
`boolean`	`isNoAutoProps()`
`boolean`	`isNoDiffAdded()`
`boolean`	`isNoDiffDeleted()`
`boolean`	`isNoIgnore()`
`boolean`	`isNoNewLine()`
`boolean`	`isNoticeAncestry()`
`boolean`	`isNoUnlock()`
`boolean`	`isParents()`
`boolean`	`isPinExternals()`
`boolean`	`isPropertiesOnly()`
`boolean`	`isQuiet()`
`boolean`	`isRecordOnly()`
`boolean`	`isReIntegrate()`
`boolean`	`isRelocate()`
`boolean`	`isRemove()`
`boolean`	`isRemoveIgnored()`
`boolean`	`isRemoveUnversioned()`
`boolean`	`isReverseDiff()`
`boolean`	`isRevisionOptionUsed()`
`boolean`	`isRevprop()`
`boolean`	`isShowCopiesAsAdds()`
`boolean`	`isShowDiff()`
`boolean`	`isShowInheritedProps()`
`boolean`	`isStopOnCopy()`
`boolean`	`isStrict()`
`boolean`	`isSummarize()`
`boolean`	`isUpdate()`
`boolean`	`isUseMergeHistory()`
`boolean`	`isVerbose()`
`boolean`	`isVersion()`
`boolean`	`isXML()`
`protected String`	`refineCommandName(String commandName, SVNCommandLine commandLine)`
`protected void`	`validateOptions(SVNCommandLine commandLine)`

Methods inherited from class org.tmatesoft.svn.cli.AbstractSVNCommandEnvironment
checkCancelled, combineTargets, createClientManager, dispose, getArguments, getClientManager, getCommand, getCommandName, getCommandName, getErr, getIn, getOptions, getOut, getProgramName, getRelativePath, getURLFromTarget, handleError, handleWarning, init, initCommand, isVersioned, parseRevision, popArgument, printCommitInfo, readFromFile, run, setArguments, setCancelled

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SVNCommandEnvironment

public SVNCommandEnvironment(String programName,
                             PrintStream out,
                             PrintStream err,
                             InputStream in)

Method Detail

initClientManager
```
public void initClientManager()
                       throws SVNException
```
Overrides:

initClientManager in class AbstractSVNCommandEnvironment

Throws:

SVNException

refineCommandName

protected String refineCommandName(String commandName,
                                   SVNCommandLine commandLine)
                            throws SVNException

Specified by:: refineCommandName in class AbstractSVNCommandEnvironment
Throws:: SVNException

createClientOptions

protected DefaultSVNOptions createClientOptions()
                                         throws SVNException

Specified by:: createClientOptions in class AbstractSVNCommandEnvironment
Throws:: SVNException

createClientAuthenticationManager
```
protected ISVNAuthenticationManager createClientAuthenticationManager()
```
Specified by:

createClientAuthenticationManager in class AbstractSVNCommandEnvironment

initOptions

protected void initOptions(SVNCommandLine commandLine)
                    throws SVNException

Overrides:: initOptions in class AbstractSVNCommandEnvironment
Throws:: SVNException

initOption

protected void initOption(SVNOptionValue optionValue)
                   throws SVNException

Specified by:: initOption in class AbstractSVNCommandEnvironment
Throws:: SVNException

getSVNCommand
```
protected SVNCommand getSVNCommand()
```

validateOptions

protected void validateOptions(SVNCommandLine commandLine)
                        throws SVNException

Overrides:: validateOptions in class AbstractSVNCommandEnvironment
Throws:: SVNException

getCommandLineClientName
```
protected String getCommandLineClientName()
```
Specified by:

getCommandLineClientName in class AbstractSVNCommandEnvironment

isReIntegrate
```
public boolean isReIntegrate()
```

getShowRevisionType

public SVNShowRevisionType getShowRevisionType()

isChangeOptionUsed
```
public boolean isChangeOptionUsed()
```

isRevisionOptionUsed
```
public boolean isRevisionOptionUsed()
```

getChangelist
```
public String getChangelist()
```

getChangelists
```
public String[] getChangelists()
```

getChangelistsCollection

public Collection getChangelistsCollection()

isIgnoreKeywords
```
public boolean isIgnoreKeywords()
```

getDepth
```
public SVNDepth getDepth()
```

getSetDepth
```
public SVNDepth getSetDepth()
```

isVerbose
```
public boolean isVerbose()
```

isNoIgnore
```
public boolean isNoIgnore()
```

isUpdate
```
public boolean isUpdate()
```

isQuiet
```
public boolean isQuiet()
```

isIncremental
```
public boolean isIncremental()
```

isRevprop
```
public boolean isRevprop()
```

isStrict
```
public boolean isStrict()
```

getRevisionRanges
```
public List getRevisionRanges()
```

getStartRevision
```
public SVNRevision getStartRevision()
```

getEndRevision
```
public SVNRevision getEndRevision()
```

isXML
```
public boolean isXML()
```

isVersion
```
public boolean isVersion()
```

isForce
```
public boolean isForce()
```

getEncoding
```
public String getEncoding()
```

getFileData
```
public byte[] getFileData()
```

getTargets
```
public List getTargets()
```

isForceLog
```
public boolean isForceLog()
```

getEditorCommand
```
public String getEditorCommand()
```

getDiffCommand
```
public String getDiffCommand()
```

getMessage
```
public String getMessage()
```

getRevisionProperties

public SVNProperties getRevisionProperties()

isDryRun
```
public boolean isDryRun()
```

isIgnoreAncestry
```
public boolean isIgnoreAncestry()
```

isShowCopiesAsAdds
```
public boolean isShowCopiesAsAdds()
```

isGitDiffFormat
```
public boolean isGitDiffFormat()
```

isPropertiesOnly
```
public boolean isPropertiesOnly()
```

isIgnoreProperties
```
public boolean isIgnoreProperties()
```

isReverseDiff
```
public boolean isReverseDiff()
```

isIgnoreWhitespace
```
public boolean isIgnoreWhitespace()
```

isShowDiff
```
public boolean isShowDiff()
```

isUseMergeHistory
```
public boolean isUseMergeHistory()
```

isRecordOnly
```
public boolean isRecordOnly()
```

getExtensions
```
public Collection getExtensions()
```

getNativeEOL
```
public String getNativeEOL()
```

isRelocate
```
public boolean isRelocate()
```

isNoUnlock
```
public boolean isNoUnlock()
```

isKeepChangelist
```
public boolean isKeepChangelist()
```

isParents
```
public boolean isParents()
```

isKeepLocal
```
public boolean isKeepLocal()
```

getResolveAccept

public SVNConflictAcceptPolicy getResolveAccept()

isRemove
```
public boolean isRemove()
```

isSummarize
```
public boolean isSummarize()
```

isNoticeAncestry
```
public boolean isNoticeAncestry()
```

isNoDiffDeleted
```
public boolean isNoDiffDeleted()
```

isNoDiffAdded
```
public boolean isNoDiffAdded()
```

getOldTarget
```
public String getOldTarget()
```

getNewTarget
```
public String getNewTarget()
```

getAuthorOfInterest
```
public String getAuthorOfInterest()
```

isNoAutoProps
```
public boolean isNoAutoProps()
```

getRegularExpression
```
public String getRegularExpression()
```

getLimit
```
public long getLimit()
```

isStopOnCopy
```
public boolean isStopOnCopy()
```

isAllRevisionProperties

public boolean isAllRevisionProperties()

getStripCount
```
public int getStripCount()
```

getDiffOptions

public SVNDiffOptions getDiffOptions()
                              throws SVNException

Throws:: SVNException

isAllowMixedRevisions

public boolean isAllowMixedRevisions()

isShowInheritedProps
```
public boolean isShowInheritedProps()
```

getShowItem
```
public String getShowItem()
```

isNoNewLine
```
public boolean isNoNewLine()
```

isPinExternals
```
public boolean isPinExternals()
```

isRemoveUnversioned
```
public boolean isRemoveUnversioned()
```

isRemoveIgnored
```
public boolean isRemoveIgnored()
```

isIncludeExternals
```
public boolean isIncludeExternals()
```

getConflictStats

public SVNConflictStats getConflictStats()

getRevisionProperties
```
public SVNProperties getRevisionProperties(String message,
                                           SVNCommitItem[] commitables,
                                           SVNProperties revisionProperties)
                                    throws SVNException
```
Description copied from interface: ISVNCommitHandler

Handles the incoming revision properties and returns filtered revision properties given the paths (represented by commitables) collected for committing and the commit log message.
Only the returned filtered revision properties will be set on a new committed revision.

Specified by:

getRevisionProperties in interface ISVNCommitHandler

Parameters:

message - log message for commit

commitables - paths to commit

revisionProperties - initial revision properties

Returns:

filtered revision properties

Throws:

SVNException

getCommitMessage
```
public String getCommitMessage(String message,
                               SVNCommitItem[] commitables)
                        throws SVNException
```
Description copied from interface: ISVNCommitHandler

Handles the incoming initial log message and items intended for a commit and returns a new commit log message.

Specified by:

getCommitMessage in interface ISVNCommitHandler

Parameters:

message - an initial log message

commitables - an array of items to be committed

Returns:

a new log message string or NULL to cancel commit operation.

Throws:

SVNException

Class SVNCommandEnvironment

Field Summary

Fields inherited from interface org.tmatesoft.svn.core.ISVNCanceller

Constructor Summary

Method Summary

Methods inherited from class org.tmatesoft.svn.cli.AbstractSVNCommandEnvironment

Methods inherited from class java.lang.Object

Constructor Detail

SVNCommandEnvironment

Method Detail

initClientManager

refineCommandName

createClientOptions

createClientAuthenticationManager

initOptions

initOption

getSVNCommand

validateOptions

getCommandLineClientName

isReIntegrate

getShowRevisionType

isChangeOptionUsed

isRevisionOptionUsed

getChangelist

getChangelists

getChangelistsCollection

isIgnoreKeywords

getDepth

getSetDepth

isVerbose

isNoIgnore

isUpdate

isQuiet

isIncremental

isRevprop

isStrict

getRevisionRanges

getStartRevision

getEndRevision

isXML

isVersion

isForce

getEncoding

getFileData

getTargets

isForceLog

getEditorCommand

getDiffCommand

getMessage

getRevisionProperties

isDryRun

isIgnoreAncestry

isShowCopiesAsAdds

isGitDiffFormat

isPropertiesOnly

isIgnoreProperties

isReverseDiff

isIgnoreWhitespace

isShowDiff

isUseMergeHistory

isRecordOnly

getExtensions

getNativeEOL

isRelocate

isNoUnlock

isKeepChangelist

isParents

isKeepLocal

getResolveAccept

isRemove

isSummarize

isNoticeAncestry

isNoDiffDeleted

isNoDiffAdded

getOldTarget

getNewTarget

getAuthorOfInterest

isNoAutoProps

getRegularExpression

getLimit