Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * ====================================================================
   * Copyright (c) 2004-2006 TMate Software Ltd.  All rights reserved.
   *
   * This software is licensed as described in the file COPYING, which
   * you should have received as part of this distribution.  The terms
   * are also available at http://svnkit.com/license.html
   * If newer versions of this license are posted there, you may use a
   * newer version instead, at your option.
  * ====================================================================
  */
 
 package org.tmatesoft.svn.core.io;
 
The ISVNEditor interface is used by SVNRepository to update versioned files/dirs, check out files/dirs from a repository, commit changes to a repository, take status of files/dirs, get differences between files.

When used for updating (checking out, getting differences or status), an implementor should provide its own appropriate implementation of the ISVNEditor interface along with a reporter baton (ISVNReposrterBaton) to a corresponding method of an SVNRepository driver. Reporter baton will be used to describe the state of local dirs/files - their current revisions, whether a file/dir is deleted or switched. An editor is invoked after the reporter baton finishes its work. It is used to "edit" the state of files/dirs, where "edit" may mean anything: applying changes in updating, switching, checking out (what really changes the state), or handling changes in getting status or differences (what is only used to inform about, show, separately store changes, and so on). The concrete behaviour of the editor is implemented by the provider of that editor.

The other kind of using ISVNEditor is committing changes to a repository. Here an editor is given to a caller, and the caller himself describes the changes of local files/dirs. All that collected info is then committed in a single transaction when a caller invokes the closeEdit() method of the editor. For more information on using editors, please, read these on-line articles:

  • Using ISVNReporter/ISVNEditor in update-related operations
  • Using ISVNEditor in commit operations

Author(s):
TMate Software Ltd.
Version:
1.1.0
See also:
ISVNReporterBaton
Examples
 
 public interface ISVNEditor extends ISVNDeltaConsumer {
    
Sets the target revision the operation is running for. For example, the target revision to which an update is running.

Parameters:
revision a revision number
Throws:
org.tmatesoft.svn.core.SVNException
 
     public void targetRevision(long revisionthrows SVNException;
    
    
Opens the root directory on which the operation was invoked. All property changes as well as entries adding/deletion will be applied to this root directory. When coming back up to this root (after traversing the entire tree) you should close the root by calling closeDir().

Parameters:
revision the revision number of the root directory
Throws:
org.tmatesoft.svn.core.SVNException
 
     public void openRoot(long revisionthrows SVNException;
    
    
Deletes an entry.

In a commit - deletes an entry from a repository. In an update - deletes an entry locally (since it has been deleted in the repository). In a status - informs that an entry has been deleted.

Parameters:
path an entry path relative to the root directory opened by openRoot()
revision the revision number of path
Throws:
org.tmatesoft.svn.core.SVNException
 
     public void deleteEntry(String pathlong revisionthrows SVNException;
    
    
Indicates that a path is present as a subdirectory in the edit source, but can not be conveyed to the edit consumer (perhaps because of authorization restrictions).

Parameters:
path a dir path relative to the root directory opened by openRoot()
Throws:
org.tmatesoft.svn.core.SVNException
 
     public void absentDir(String paththrows SVNException;
    
    
Indicates that a path is present as a file in the edit source, but can not be conveyed to the edit consumer (perhaps because of authorization restrictions).

Parameters:
path a file path relative to the root directory opened by openRoot()
Throws:
org.tmatesoft.svn.core.SVNException
    public void absentFile(String paththrows SVNException;
    
    
Adds a directory.

In a commit - adds a new directory to a repository. In an update - locally adds a directory that was added in the repository. In a status - informs about a new directory scheduled for addition.

If copyFromPath is not null then it says that path is copied from copyFromPath located in copyFromRevision.

Parameters:
path a directory path relative to the root directory opened by openRoot()
copyFromPath an ancestor of the added directory
copyFromRevision the revision of the ancestor
Throws:
org.tmatesoft.svn.core.SVNException
    public void addDir(String pathString copyFromPathlong copyFromRevisionthrows SVNException;
    
    
Opens a directory. All property changes as well as entries adding/deletion can be applied to this directory.

Parameters:
path a directory path relative to the root directory opened by openRoot()
revision the revision of the directory
Throws:
org.tmatesoft.svn.core.SVNException
	public void openDir(String pathlong revisionthrows SVNException;
    
Changes the value of a property of the currently "opened"/"added" directory.

Parameters:
name the name of a property to be changed
value new property value
Throws:
org.tmatesoft.svn.core.SVNException
See also:
openDir(java.lang.String,long)
    public void changeDirProperty(String nameString valuethrows SVNException;

    
Closes the currently opened directory fixing all changes of its properties and/or entries. Closing a directory picks up an editor to a parent directory.

    public void closeDir() throws SVNException;
    
    
Adds a file.

In a commit - adds a new file to a repository. In an update - locally adds a file that was added in the repository. In a status - informs about a new file scheduled for addition.

If copyFromPath is not null then it says that path is copied from copyFromPath located in copyFromRevision.

Parameters:
path a file path relative to the root directory opened by openRoot()
copyFromPath an ancestor of the added file
copyFromRevision the revision of the ancestor
Throws:
org.tmatesoft.svn.core.SVNException
    public void addFile(String pathString copyFromPathlong copyFromRevisionthrows SVNException;
    
    
Opens a file. After it's opened, apply delta to its contents or change the file properties.

Parameters:
path a file path relative to the root directory opened by openRoot()
revision the revision of the file
Throws:
org.tmatesoft.svn.core.SVNException
    public void openFile(String pathlong revisionthrows SVNException;
    
    
Changes the value of a property of an opened file.

Parameters:
path a file path relative to the root directory opened by openRoot()
name a file property name
value a new value for the property
Throws:
org.tmatesoft.svn.core.SVNException
    public void changeFileProperty(String pathString nameString valuethrows SVNException;
    
    
Closes the opened file fixing all properties and/or contents changes.

Parameters:
path a file path relative to the root directory opened by openRoot()
textChecksum an MD5 checksum for the modified file
Throws:
org.tmatesoft.svn.core.SVNException if the calculated upon the actual changed contents checksum does not match the expected textChecksum
    public void closeFile(String pathString textChecksumthrows SVNException;
    
    
Closes this editor finalizing the whole operation the editor was used for. In a commit - sends collected data to commit a transaction.

Returns:
a committed revision information
Throws:
org.tmatesoft.svn.core.SVNException
    public SVNCommitInfo closeEdit() throws SVNException;
    
    
Aborts the current running editor due to errors occured.

If an exception is thrown from an editor's method, call this method to abort the editor.

    public void abortEdit() throws SVNException;
New to GrepCode? Check out our FAQ X