Package org.tmatesoft.svn.core.internal.wc

Class SVNStatusReporter

java.lang.Object

org.tmatesoft.svn.core.internal.wc.SVNStatusReporter

All Implemented Interfaces:

ISVNReporter, ISVNReporterBaton

public class SVNStatusReporter
extends java.lang.Object
implements ISVNReporterBaton, ISVNReporter

Version:

1.3

Field Summary

Fields

Modifier and Type	Field	Description
private ISVNReporterBaton	myBaton
private SVNURL	myCommonAncestorLocation
private SVNStatusEditor	myEditor
private java.util.Map	myLocks
private ISVNReporter	myReporter
private SVNRepository	myRepository
private SVNURL	myRepositoryRoot

Constructor Summary

Constructors

Constructor	Description
SVNStatusReporter(SVNRepository repos, ISVNReporterBaton baton, SVNStatusEditor editor)

Method Summary

Modifier and Type	Method	Description
void	abortReport()	Aborts the current running report due to errors occured.
void	deletePath(java.lang.String path)	Describes a working copy path as deleted or missing.
void	finishReport()	Finalizes the report.
SVNLock	getLock(SVNURL url)
void	linkPath(SVNURL url, java.lang.String path, java.lang.String lockToken, long revision, boolean startEmpty)	Describes a local path as being at a particular revision to switch the path to a different repository location.
void	linkPath(SVNURL url, java.lang.String path, java.lang.String lockToken, long revision, SVNDepth depth, boolean startEmpty)	Describes a local path as being at a particular revision to switch the path to a different repository location.
void	report(ISVNReporter reporter)	Makes a report describing the state of local items in order to get the differences between the local items and what actually is in a repository.
void	setPath(java.lang.String path, java.lang.String lockToken, long revision, boolean startEmpty)	Describes a local path as being at a particular revision.
void	setPath(java.lang.String path, java.lang.String lockToken, long revision, SVNDepth depth, boolean startEmpty)	Describes a working copy path as being at a particular revision and having depth depth.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

myReporter

private ISVNReporter myReporter

myBaton

private ISVNReporterBaton myBaton

myCommonAncestorLocation

private SVNURL myCommonAncestorLocation

myRepository

private SVNRepository myRepository

myRepositoryRoot

private SVNURL myRepositoryRoot

myLocks

private java.util.Map myLocks

myEditor

private SVNStatusEditor myEditor

Constructor Detail

SVNStatusReporter

public SVNStatusReporter(SVNRepository repos,
                         ISVNReporterBaton baton,
                         SVNStatusEditor editor)

Method Detail

getLock

public SVNLock getLock(SVNURL url)

report

public void report(ISVNReporter reporter)
            throws SVNException

Description copied from interface: ISVNReporterBaton

Makes a report describing the state of local items in order to get the differences between the local items and what actually is in a repository.

Specified by:

report in interface ISVNReporterBaton

Parameters:

reporter - a reporter passed to make reports

Throws:

SVNException

setPath

public void setPath(java.lang.String path,
                    java.lang.String lockToken,
                    long revision,
                    boolean startEmpty)
             throws SVNException

Description copied from interface: ISVNReporter

Describes a local path as being at a particular revision.

If startEmpty is true and the path is a directory, an implementor should assume the directory has no entries or properties (used in checkouts and aborted updates).

A next call to this method will "override" any previous setPath() calls made on parent paths. The path is relative to the repository location specified for an SVNRepository driver.

Specified by:

setPath in interface ISVNReporter

Parameters:

path - a local item's path

lockToken - if not null, it is a lock token for the path

revision - the local item's revision number

startEmpty - if true and if the path is a directory, then means there're no entries yet

Throws:

SVNException - in case the repository could not be connected

deletePath

public void deletePath(java.lang.String path)
                throws SVNException

Description copied from interface: ISVNReporter

Describes a working copy path as deleted or missing.

Specified by:

deletePath in interface ISVNReporter

Parameters:

path - a path relative to the root of the report

Throws:

SVNException - in case the repository could not be connected

linkPath

public void linkPath(SVNURL url,
                     java.lang.String path,
                     java.lang.String lockToken,
                     long revision,
                     boolean startEmpty)
              throws SVNException

Description copied from interface: ISVNReporter

Describes a local path as being at a particular revision to switch the path to a different repository location.

Like setPath(), but differs in that the local item's path (relative to the root of the report driver) isn't a reflection of the path in the repository, but is instead a reflection of a different repository path at a revision.

If startEmpty is set and the path is a directory, the implementor should assume the directory has no entries or properties.

Specified by:

linkPath in interface ISVNReporter

Parameters:

url - a new repository location to switch to

path - the local item's path

lockToken - if not null, it is a lock token for the path

revision - the local item's revision number

startEmpty - if true and if the path is a directory, then means there're no entries yet

Throws:

SVNException - in case the repository could not be connected

finishReport

public void finishReport()
                  throws SVNException

Description copied from interface: ISVNReporter

Finalizes the report. Must be called when having traversed a local tree of paths.

Any directories or files not explicitly set (described) are assumed to be at the baseline revision.

Specified by:

finishReport in interface ISVNReporter

Throws:

SVNException - in case the repository could not be connected

abortReport

public void abortReport()
                 throws SVNException

Description copied from interface: ISVNReporter

Aborts the current running report due to errors occured.

If an error occurs during a report, call this method to abort the reporter correctly.

Specified by:

abortReport in interface ISVNReporter

Throws:

SVNException - in case the repository could not be connected

linkPath

public void linkPath(SVNURL url,
                     java.lang.String path,
                     java.lang.String lockToken,
                     long revision,
                     SVNDepth depth,
                     boolean startEmpty)
              throws SVNException

Description copied from interface: ISVNReporter

Describes a local path as being at a particular revision to switch the path to a different repository location.

Like ISVNReporter.setPath(String, String, long, SVNDepth, boolean), but differs in that the local item's path (relative to the root of the report driver) isn't a reflection of the path in the repository, but is instead a reflection of a different repository url at revision, and has depth depth.

path may not be underneath a path on which ISVNReporter.setPath(String, String, long, SVNDepth, boolean) was previously called with SVNDepth.EXCLUDE in this report. If startEmpty is set and path is a directory, that will mean that the directory has no entries or props.

If lockToken is non-null, it is the lock token for path in the local tree.

Specified by:

linkPath in interface ISVNReporter

Parameters:

url - a new repository location to switch to

path - the local item's path

lockToken - if not null, it is a lock token for the path

revision - the local item's revision number

depth - depth of path

startEmpty - if true and if the path is a directory, then means there're no entries yet

Throws:

SVNException - in case the repository could not be connected

setPath

public void setPath(java.lang.String path,
                    java.lang.String lockToken,
                    long revision,
                    SVNDepth depth,
                    boolean startEmpty)
             throws SVNException

Description copied from interface: ISVNReporter

Describes a working copy path as being at a particular revision and having depth depth.

revision may be invalid (<0) if (for example) path represents a locally-added path with no revision number, or depth is SVNDepth.EXCLUDE.

path may not be underneath a path on which setPath() was previously called with SVNDepth.EXCLUDE in this report.

If startEmpty is set and path is a directory, this will mean that the directory has no entries or properties.

This will *override* any previous setPath() calls made on parent paths.

path is relative to the location of the repository access object.

If lockToken is non-null, it is the lock token for path in the local tree.

Specified by:

setPath in interface ISVNReporter

Parameters:

path - a local item's path

lockToken - if not null, it is a lock token for the path

revision - the local item's revision number

depth - depth of path

startEmpty - if true and if the path is a directory, then means there're no entries yet

Throws:

SVNException - in case the repository could not be connected