Package org.tmatesoft.svn.core.wc2
Class SvnAnnotate
- java.lang.Object
-
- org.tmatesoft.svn.core.wc2.SvnOperation<T>
-
- org.tmatesoft.svn.core.wc2.SvnReceivingOperation<SvnAnnotateItem>
-
- org.tmatesoft.svn.core.wc2.SvnAnnotate
-
- All Implemented Interfaces:
ISvnObjectReceiver<SvnAnnotateItem>
,ISvnOperationOptionsProvider
public class SvnAnnotate extends SvnReceivingOperation<SvnAnnotateItem>
Represents annotate operation. Obtains and reports annotation information for each line-blame item associated with revisionendRevision
oftarget
, usingstartRevision
as the default source of all blame. Passes annotation information to a annotation handler if provided.Target
can represent URL or working copy path (used to get corresponding URLs).Target
'spegRevision
indicates in which revisiontarget
is valid. IfpegRevision
isSVNRevision.UNDEFINED
, then it defaults toSVNRevision.HEAD
.-
If working copy is SVN 1.7 working copy:
If
endRevision
isSVNRevision.UNDEFINED
, then it defaults toSVNRevision.HEAD
iftarget
is URL orSVNRevision.WORKING
iftarget
is working copy path. -
If working copy is SVN 1.6 working copy:
If
startRevision
isnull
orinvalid
, then it defaults to revision 1. IfendRevision
isnull
orinvalid
, then it defaults totarget
'spegRevision
.
SvnOperation.run()
method returnsSvnAnnotateItem
information reported by the operation.SvnOperation.run()
throwsSVNException
in the following cases:-
exception with
SVNErrorCode.CLIENT_BAD_REVISION
error code - ifstartRevision
is older thanendRevision
exception withSVNErrorCode.CLIENT_BAD_REVISION
error code - if bothstartRevision
andendRevision
are eithernull
orinvalid
exception withSVNErrorCode.CLIENT_IS_BINARY_FILE
error code - if any of the revisions oftarget
's path have a binary mime-type, unlessignoreMimeType
istrue
, in which case blame information will be generated regardless of the MIME types of the revisions exception withSVNErrorCode.UNSUPPORTED_FEATURE
error code - if eitherstartRevision
orendRevision
isSVNRevision.WORKING
(for SVN 1.6 working copy only).- Version:
- 1.7
-
-
Field Summary
Fields Modifier and Type Field Description private SVNDiffOptions
diffOptions
private SVNRevision
endRevision
private ISVNAnnotateHandler
handler
private boolean
ignoreMimeType
private java.lang.String
inputEncoding
private SVNRevision
startRevision
private boolean
useMergeHistory
-
Constructor Summary
Constructors Modifier Constructor Description protected
SvnAnnotate(SvnOperationFactory factory)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SVNDiffOptions
getDiffOptions()
Gets diff options for the operation.SVNRevision
getEndRevision()
Gets the revision of the operation to end with.ISVNAnnotateHandler
getHandler()
Gets the caller's handler to process annotation information.java.lang.String
getInputEncoding()
Gets the name of character set to decode input bytes.SVNRevision
getStartRevision()
Gets the revision of the operation to start from.boolean
isChangesWorkingCopy()
Gets whether the operation changes working copyboolean
isIgnoreMimeType()
Gets whether or not operation should be run on all files treated as text, no matter what SVNKit has inferred from the mime-type property.boolean
isUseMergeHistory()
Gets whether or not data based upon revisions which have been merged to targets also should be returned.void
setDiffOptions(SVNDiffOptions diffOptions)
Sets diff options for the operation.void
setEndRevision(SVNRevision endRevision)
Sets the revision of the operation to end with.void
setHandler(ISVNAnnotateHandler handler)
Sets the caller's handler to process annotation information.void
setIgnoreMimeType(boolean ignoreMimeType)
Sets whether or not operation should be run on all files treated as text, no matter what SVNKit has inferred from the mime-type property.void
setInputEncoding(java.lang.String inputEncoding)
Sets the name of character set to decode input bytes.void
setStartRevision(SVNRevision startRevision)
Sets the revision of the operation to start from.void
setUseMergeHistory(boolean useMergeHistory)
Sets whether or not data based upon revisions which have been merged to targets also should be returned.-
Methods inherited from class org.tmatesoft.svn.core.wc2.SvnReceivingOperation
first, getReceiver, initDefaults, last, receive, run, setReceiver
-
Methods inherited from class org.tmatesoft.svn.core.wc2.SvnOperation
addTarget, cancel, ensureArgumentsAreValid, ensureEnoughTargets, ensureHomohenousTargets, getApplicableChangelists, getAuthenticationManager, getCanceller, getDepth, getEventHandler, getFirstTarget, getMaximumTargetsCount, getMinimumTargetsCount, getOperationalWorkingCopy, getOperationFactory, getOptions, getRepositoryPool, getRevision, getSqliteJournalMode, getTargets, hasFileTargets, hasLocalTargets, hasRemoteTargets, isCancelled, isSleepForTimestamp, isUseParentWcFormat, needsHomohenousTargets, run, setApplicalbeChangelists, setDepth, setRevision, setSingleTarget, setSleepForTimestamp, setSqliteJournalMode
-
-
-
-
Field Detail
-
useMergeHistory
private boolean useMergeHistory
-
ignoreMimeType
private boolean ignoreMimeType
-
handler
private ISVNAnnotateHandler handler
-
startRevision
private SVNRevision startRevision
-
endRevision
private SVNRevision endRevision
-
inputEncoding
private java.lang.String inputEncoding
-
diffOptions
private SVNDiffOptions diffOptions
-
-
Constructor Detail
-
SvnAnnotate
protected SvnAnnotate(SvnOperationFactory factory)
-
-
Method Detail
-
getHandler
public ISVNAnnotateHandler getHandler()
Gets the caller's handler to process annotation information.- Returns:
- handler to process annotation information if set
-
setHandler
public void setHandler(ISVNAnnotateHandler handler)
Sets the caller's handler to process annotation information.- Parameters:
handler
- handler to process annotation information
-
isUseMergeHistory
public boolean isUseMergeHistory()
Gets whether or not data based upon revisions which have been merged to targets also should be returned.- Returns:
true
if merged history should be used, otherwisefalse
-
setUseMergeHistory
public void setUseMergeHistory(boolean useMergeHistory)
Sets whether or not data based upon revisions which have been merged to targets also should be returned.- Parameters:
useMergeHistory
-true
if merged history should be use, otherwisefalse
-
isIgnoreMimeType
public boolean isIgnoreMimeType()
Gets whether or not operation should be run on all files treated as text, no matter what SVNKit has inferred from the mime-type property.- Returns:
true
if mime types should be ignored, otherwisefalse
-
setIgnoreMimeType
public void setIgnoreMimeType(boolean ignoreMimeType)
Sets whether or not operation should be run on all files treated as text, no matter what SVNKit has inferred from the mime-type property.- Parameters:
ignoreMimeType
-true
if mime types should be ignored, otherwisefalse
-
getStartRevision
public SVNRevision getStartRevision()
Gets the revision of the operation to start from.- Returns:
- revision to start from
-
setStartRevision
public void setStartRevision(SVNRevision startRevision)
Sets the revision of the operation to start from.- Parameters:
startRevision
- revision to start from
-
getEndRevision
public SVNRevision getEndRevision()
Gets the revision of the operation to end with.- Returns:
- revision to end with
-
setEndRevision
public void setEndRevision(SVNRevision endRevision)
Sets the revision of the operation to end with.- Parameters:
endRevision
- revision to end with
-
getInputEncoding
public java.lang.String getInputEncoding()
Gets the name of character set to decode input bytes.- Returns:
- name of character set
-
setInputEncoding
public void setInputEncoding(java.lang.String inputEncoding)
Sets the name of character set to decode input bytes.- Parameters:
inputEncoding
- name of character set
-
getDiffOptions
public SVNDiffOptions getDiffOptions()
Gets diff options for the operation.- Returns:
- diff options
-
setDiffOptions
public void setDiffOptions(SVNDiffOptions diffOptions)
Sets diff options for the operation.- Parameters:
diffOptions
- diff options
-
isChangesWorkingCopy
public boolean isChangesWorkingCopy()
Gets whether the operation changes working copy- Overrides:
isChangesWorkingCopy
in classSvnOperation<SvnAnnotateItem>
- Returns:
true
if the operation changes the working copy, otherwisefalse
-
-