Package org.tmatesoft.svn.core.wc2
Class SvnGetStatus
- java.lang.Object
-
- org.tmatesoft.svn.core.wc2.SvnOperation<T>
-
- org.tmatesoft.svn.core.wc2.SvnReceivingOperation<SvnStatus>
-
- org.tmatesoft.svn.core.wc2.SvnGetStatus
-
- All Implemented Interfaces:
ISvnObjectReceiver<SvnStatus>
,ISvnOperationOptionsProvider
public class SvnGetStatus extends SvnReceivingOperation<SvnStatus>
Represents status operation.SvnOperation.run()
method returns a set ofSvnStatus
objects which describe the status of the working copetarget
, and its children (recursing according todepth
).. IfreportAll
is set, retrieves all entries; otherwise, retrieves only "interesting" entries (local modifications and/or out of date). Ifremote
is set, contacts the repository and augments the status objects with information about out-of-date items (with respect torevision
). IfreportExternals
istrue, then recurses into externals definitions (if any exist and depth
is eitherSVNDepth.INFINITY
orSVNDepth.UNKNOWN
) after handling the maintarget
. This calls the client notification handler (ISVNEventHandler
) with theSVNEventAction.STATUS_EXTERNAL
action before handling each externals definition, and withSVNEventAction.STATUS_COMPLETED
after each.changeLists
is a collection ofString
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. IfchangeLists
is empty (ornull
), no changelist filtering occurs. ifremote
istrue, status is calculated against this
revision
- Version:
- 1.7
- Author:
- TMate Software Ltd.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
SvnGetStatus(SvnOperationFactory factory)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
ensureArgumentsAreValid()
ISvnFileListHook
getFileListHook()
Returns client's file list hook.long
getRemoteRevision()
Returns the remove revision of thetarget
.void
initDefaults()
boolean
isChangesWorkingCopy()
Gets whether the operation changes working copyboolean
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 thetarget
.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).-
Methods inherited from class org.tmatesoft.svn.core.wc2.SvnReceivingOperation
first, getReceiver, last, receive, run, setReceiver
-
Methods inherited from class org.tmatesoft.svn.core.wc2.SvnOperation
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
-
-
-
-
Constructor Detail
-
SvnGetStatus
protected SvnGetStatus(SvnOperationFactory factory)
-
-
Method Detail
-
isRemote
public 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)- Returns:
true
if the status should be checked up in repository, otherwisefalse
-
isDepthAsSticky
public boolean isDepthAsSticky()
Returns whether depth is sticky. IfdepthIsSticky
is set anddepth
is notSVNDepth.UNKNOWN
, then in addition to switchingtarget
's path , also sets its sticky ambient depth value todepth
.- Returns:
true
if the depth is sticky, otherwisefalse
-
isReportIgnored
public 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).- Returns:
true
if default and svn:ignore property ignores should be disregarded, otherwisefalse
-
isReportAll
public boolean isReportAll()
Returns whether to collect status information on all items including those ones that are in a 'normal' state (unchanged).- Returns:
true
if all items are reported, iffalse
only items with unchanged state
-
isReportExternals
public boolean isReportExternals()
Returns whether to report externals.- Returns:
true
if externals should be reported, otherwisefalse
-
getFileListHook
public ISvnFileListHook getFileListHook()
Returns client's file list hook. Used for 1.6 only, formerISVNStatusFileProvider
.- Returns:
- file list hook
-
setRemote
public 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)- Parameters:
remote
-true
if the status should be checked up in repository, otherwisefalse
-
setDepthAsSticky
public void setDepthAsSticky(boolean depthAsSticky)
- Parameters:
depthAsSticky
-
-
setReportIgnored
public 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).- Parameters:
reportIgnored
-true
if default and svn:ignore property ignores should be disregarded, otherwisefalse
-
setReportAll
public void setReportAll(boolean reportAll)
Sets whether to collect status information on all items including those ones that are in a 'normal' state (unchanged).- Parameters:
reportAll
-true
if all items are reported, iffalse
only items with unchanged state
-
setReportExternals
public void setReportExternals(boolean reportExternals)
Sets whether to report externals.- Parameters:
reportExternals
-true
if externals should be reported, otherwisefalse
-
setFileListHook
public void setFileListHook(ISvnFileListHook fileListHook)
Sets client's file list hook. Used for 1.6 only, formerISVNStatusFileProvider
.- Parameters:
fileListHook
- file list hook
-
ensureArgumentsAreValid
protected void ensureArgumentsAreValid() throws SVNException
- Overrides:
ensureArgumentsAreValid
in classSvnOperation<SvnStatus>
- Throws:
SVNException
-
initDefaults
public void initDefaults()
- Overrides:
initDefaults
in classSvnReceivingOperation<SvnStatus>
-
isCollectParentExternals
public boolean isCollectParentExternals()
Only relevant for 1.6 working copies, obsolete (not used).
-
setCollectParentExternals
public void setCollectParentExternals(boolean collect)
Only relevant for 1.6 working copies, obsolete (not used).
-
setRemoteRevision
public void setRemoteRevision(long revision)
Sets the remove revision of thetarget
.- Parameters:
revision
- remote revision
-
getRemoteRevision
public long getRemoteRevision()
Returns the remove revision of thetarget
. This value can be accessed after operation is executed.- Returns:
- revision remote revision
-
isUseParentWcFormat
public boolean isUseParentWcFormat()
Description copied from class:SvnOperation
Gets whether or not to use parent working copy format.- Overrides:
isUseParentWcFormat
in classSvnOperation<SvnStatus>
- Returns:
true
if parent working copy format should be used, otherwisefalse
-
isChangesWorkingCopy
public boolean isChangesWorkingCopy()
Gets whether the operation changes working copy- Overrides:
isChangesWorkingCopy
in classSvnOperation<SvnStatus>
- Returns:
true
if the operation changes the working copy, otherwisefalse
-
-