public class SvnGetStatus extends SvnReceivingOperation<SvnStatus>
SvnOperation.run()
method returns a set of SvnStatus
objects which
describe the status of the working cope target
, and its children (recursing
according to depth
)..
If reportAll
is set, retrieves all entries; otherwise,
retrieves only "interesting" entries (local modifications and/or out of
date).
If remote
is set, contacts the repository and augments the
status objects with information about out-of-date items (with respect to
revision
).
If reportExternals
is depth
is either
SVNDepth.INFINITY
or SVNDepth.UNKNOWN
) after handling the
main target
. This calls the client notification handler (
ISVNEventHandler
) with the SVNEventAction.STATUS_EXTERNAL
action before handling each externals definition, and with
SVNEventAction.STATUS_COMPLETED
after each.
changeLists
is a collection of String
changelist names, used as a restrictive filter on items whose statuses
are reported; that is, doesn't report status about any item unless it's a
member of one of those changelists. If changeLists
is empty
(or null
), no changelist filtering
occurs.
if remote
is true, status is calculated against
this revision
Modifier | Constructor and Description |
---|---|
protected |
SvnGetStatus(SvnOperationFactory factory) |
Modifier and Type | Method and Description |
---|---|
protected void |
ensureArgumentsAreValid() |
ISvnFileListHook |
getFileListHook()
Returns client's file list hook.
|
long |
getRemoteRevision()
Returns the remove revision of the
target . |
void |
initDefaults() |
boolean |
isChangesWorkingCopy()
Gets whether the operation changes working copy
|
boolean |
isCollectParentExternals()
Only relevant for 1.6 working copies, obsolete (not used).
|
boolean |
isDepthAsSticky()
Returns whether depth is sticky.
|
boolean |
isRemote()
Returns whether to check up the status of the item in the repository,
that will tell if the local item is out-of-date
(like '-u' option in the SVN client's
'svn status' command) |
boolean |
isReportAll()
Returns whether to collect status information on all items
including those ones that are in a 'normal' state (unchanged).
|
boolean |
isReportExternals()
Returns whether to report externals.
|
boolean |
isReportIgnored()
Returns whether to force the operation to collect information
on items that were set to be ignored (like '--no-ignore'
option in the SVN client's
'svn status' command
to disregard default and 'svn:ignore' property ignores). |
boolean |
isUseParentWcFormat()
Gets whether or not to use parent working copy format.
|
void |
setCollectParentExternals(boolean collect)
Only relevant for 1.6 working copies, obsolete (not used).
|
void |
setDepthAsSticky(boolean depthAsSticky) |
void |
setFileListHook(ISvnFileListHook fileListHook)
Sets client's file list hook.
|
void |
setRemote(boolean remote)
Sets whether to check up the status of the item in the repository,
that will tell if the local item is out-of-date
(like '-u' option in the SVN client's
'svn status' command) |
void |
setRemoteRevision(long revision)
Sets the remove revision of the
target . |
void |
setReportAll(boolean reportAll)
Sets whether to collect status information on all items
including those ones that are in a 'normal' state (unchanged).
|
void |
setReportExternals(boolean reportExternals)
Sets whether to report externals.
|
void |
setReportIgnored(boolean reportIgnored)
Sets whether to force the operation to collect information
on items that were set to be ignored (like '--no-ignore'
option in the SVN client's
'svn status' command
to disregard default and 'svn:ignore' property ignores). |
first, getReceiver, last, receive, run, setReceiver
addTarget, cancel, ensureEnoughTargets, ensureHomohenousTargets, getApplicableChangelists, getAuthenticationManager, getCanceller, getDepth, getEventHandler, getFirstTarget, getMaximumTargetsCount, getMinimumTargetsCount, getOperationalWorkingCopy, getOperationFactory, getOptions, getRepositoryPool, getRevision, getSqliteJournalMode, getTargets, hasFileTargets, hasLocalTargets, hasRemoteTargets, isCancelled, isSleepForTimestamp, needsHomohenousTargets, run, setApplicalbeChangelists, setDepth, setRevision, setSingleTarget, setSleepForTimestamp, setSqliteJournalMode
protected SvnGetStatus(SvnOperationFactory factory)
public boolean isRemote()
'svn status'
command)true
if the status should be checked up in repository, otherwise false
public boolean isDepthAsSticky()
depthIsSticky
is set and depth
is not
SVNDepth.UNKNOWN
, then in addition to switching target
's path
, also sets its sticky ambient depth value to depth
.true
if the depth is sticky, otherwise false
public boolean isReportIgnored()
'svn status'
command
to disregard default and 'svn:ignore' property ignores).true
if default and svn:ignore property ignores should be disregarded, otherwise false
public boolean isReportAll()
true
if all items are reported, if false
only items with unchanged statepublic boolean isReportExternals()
true
if externals should be reported, otherwise false
public ISvnFileListHook getFileListHook()
ISVNStatusFileProvider
.public void setRemote(boolean remote)
'svn status'
command)remote
- true
if the status should be checked up in repository, otherwise false
public void setDepthAsSticky(boolean depthAsSticky)
depthAsSticky
- public void setReportIgnored(boolean reportIgnored)
'svn status'
command
to disregard default and 'svn:ignore' property ignores).reportIgnored
- true
if default and svn:ignore property ignores should be disregarded, otherwise false
public void setReportAll(boolean reportAll)
reportAll
- true
if all items are reported, if false
only items with unchanged statepublic void setReportExternals(boolean reportExternals)
reportExternals
- true
if externals should be reported, otherwise false
public void setFileListHook(ISvnFileListHook fileListHook)
ISVNStatusFileProvider
.fileListHook
- file list hookprotected void ensureArgumentsAreValid() throws SVNException
ensureArgumentsAreValid
in class SvnOperation<SvnStatus>
SVNException
public void initDefaults()
initDefaults
in class SvnReceivingOperation<SvnStatus>
public boolean isCollectParentExternals()
public void setCollectParentExternals(boolean collect)
public void setRemoteRevision(long revision)
target
.revision
- remote revisionpublic long getRemoteRevision()
target
.
This value can be accessed after operation is executed.public boolean isUseParentWcFormat()
SvnOperation
isUseParentWcFormat
in class SvnOperation<SvnStatus>
true
if parent working copy format should be used, otherwise false
public boolean isChangesWorkingCopy()
isChangesWorkingCopy
in class SvnOperation<SvnStatus>
true
if the operation changes the working copy, otherwise false
Copyright © 2004-2012 TMate Software Ltd. All Rights Reserved.