SVNKit Home

## org.tmatesoft.svn.core.io
Interface ISVNReporter

public interface ISVNReporter

The ISVNReporter interface provides methods to describe the state of local paths in order to get the differences in revisions between those local paths and what is actually in the repository.

ISVNReporter objects are used by ISVNReporterBaton implementations, provided by callers of the SVNRepository's update, switch, status, diff operations.

Paths for report calls are relative to the target of the operation (that is the directory where the command was run). Report calls must be made in depth-first order: parents before children, all children of a parent before any siblings of the parent. The first report call must be a `setPath()` with a path argument of "" and a valid revision. If the target of the operation is locally deleted or missing, use the root path's revision. If the target of the operation is deleted or switched relative to the root path, follow up the initial `setPath()` call with a `linkPath()` or `deletePath()` call with a path argument of "" to indicate that. In no other case may there be two report descriptions for the same path. If the target of the operation is a locally added file or directory (which previously did not exist), it may be reported as having revision 0 or as having the parent directory's revision. For more information on using reporters, please, read these on-line article: Using ISVNReporter/ISVNEditor in update-related operations

Version:
  1.1.1
Author:
  TMate Software Ltd.
See Also:
  `ISVNReporterBaton`, `SVNRepository`, Examples

Method Summary
`void` `abortReport()` Aborts the current running report due to errors occured.
`void` `deletePath(String path)` Describes a working copy `path` as deleted or missing.
`void` `finishReport()` Finalizes the report.
`void` `linkPath(SVNURL url, String path, String lockToken, long revison, boolean startEmpty)` Describes a local path as being at a particular revision to switch the path to a different repository location.
`void` `setPath(String path, String lockToken, long revision, boolean startEmpty)` Describes a local path as being at a particular revision.

Method Detail

### setPath

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

  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.

  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`

### deletePath

    public void deletePath(String path)
                    throws SVNException

  Describes a working copy `path` as deleted or missing.

  Parameters:
    `path` - a path relative to the root of the report
  Throws:
    `SVNException`

### linkPath

    public void linkPath(SVNURL url,
                         String path,
                         String lockToken,
                         long revison,
                         boolean startEmpty)
                  throws SVNException

  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.

  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`
    `revison` - 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`

### finishReport

    public void finishReport()
                      throws SVNException

  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.

  Throws:
    `SVNException`

### abortReport

    public void abortReport()
                     throws SVNException

  Aborts the current running report due to errors occured.

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

  Throws:
    `SVNException`

SVNKit Home

Copyright © 2004-2008 TMate Software Ltd. All Rights Reserved.