Package org.tmatesoft.svn.core.internal.wc17.db

Class SvnExternalUpdateEditor

java.lang.Object
org.tmatesoft.svn.core.internal.wc17.db.SvnExternalUpdateEditor
All Implemented Interfaces:
ISVNUpdateEditor, ISVNDeltaConsumer, ISVNEditor
public class SvnExternalUpdateEditor extends Object implements ISVNUpdateEditor

  • Field Details

    • targetRevision

      private long targetRevision

    • name

      private String name

    • originalRevision

      private long originalRevision

    • localAbsPath

      private File localAbsPath

    • context

      private SVNWCContext context

    • originalChecksum

      private SvnChecksum originalChecksum

    • wriAbsPath

      private File wriAbsPath

    • deltaProcessor

      private SVNDeltaProcessor deltaProcessor

    • currentBase

      private SVNWCContext.WritableBaseInfo currentBase

    • davPropChanges

      private SVNProperties davPropChanges

    • entryPropChanges

      private SVNProperties entryPropChanges

    • regularPropChanges

      private SVNProperties regularPropChanges

    • url

      private SVNURL url

    • reposRootUrl

      private SVNURL reposRootUrl

    • changedRev

      private long changedRev

    • changedAuthor

      private String changedAuthor

    • changedDate

      private SVNDate changedDate

    • extPatterns

      private String[] extPatterns

    • useCommitTimes

      private boolean useCommitTimes

    • reposUuid

      private String reposUuid

    • recordAncestorAbspath

      private File recordAncestorAbspath

    • recordedReposRelPath

      private File recordedReposRelPath

    • recordedPegRevision

      private long recordedPegRevision

    • recordedRevision

      private long recordedRevision

    • newMd5Checksum

      private SvnChecksum newMd5Checksum

    • newSha1Checksum

      private SvnChecksum newSha1Checksum

    • fileClosed

      private boolean fileClosed

    • iprops

      private Map<String,SVNProperties> iprops

    • added

      private boolean added

  • Constructor Details

    • SvnExternalUpdateEditor

      public SvnExternalUpdateEditor()

  • Method Details

    • createEditor

      public static ISVNUpdateEditor createEditor(SVNWCContext context, File localAbsPath, File wriAbsPath, SVNURL url, SVNURL reposRootUrl, String reposUuid, Map<String,SVNProperties> iprops, boolean useCommitTimes, String[] preservedExts, File recordAncestorAbsPath, SVNURL recordedUrl, SVNRevision recordedPegRev, SVNRevision recordedRev)

    • targetRevision

      public void targetRevision(long revision) throws SVNException
      Description copied from interface: ISVNEditor
      Sets the target revision the operation is running for. For example, the target revision to which an update is running.
      Specified by:
      targetRevision in interface ISVNEditor
      Parameters:
      revision - a revision number
      Throws:
      SVNException

    • openRoot

      public void openRoot(long revision) throws SVNException
      Description copied from interface: ISVNEditor
      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 ISVNEditor.closeDir().
      Specified by:
      openRoot in interface ISVNEditor
      Parameters:
      revision - the revision number of the root directory
      Throws:
      SVNException

    • deleteEntry

      public void deleteEntry(String path, long revision) throws SVNException
      Description copied from interface: ISVNEditor
      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.

      Specified by:
      deleteEntry in interface ISVNEditor
      Parameters:
      path - an entry path relative to the root directory opened by openRoot()
      revision - the revision number of path
      Throws:
      SVNException

    • absentDir

      public void absentDir(String path) throws SVNException
      Description copied from interface: ISVNEditor
      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).
      Specified by:
      absentDir in interface ISVNEditor
      Parameters:
      path - a dir path relative to the root directory opened by openRoot()
      Throws:
      SVNException

    • absentFile

      public void absentFile(String path) throws SVNException
      Description copied from interface: ISVNEditor
      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).
      Specified by:
      absentFile in interface ISVNEditor
      Parameters:
      path - a file path relative to the root directory opened by openRoot()
      Throws:
      SVNException

    • addDir

      public void addDir(String path, String copyFromPath, long copyFromRevision) throws SVNException
      Description copied from interface: ISVNEditor
      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.

      Specified by:
      addDir in interface ISVNEditor
      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:
      SVNException

    • openDir

      public void openDir(String path, long revision) throws SVNException
      Description copied from interface: ISVNEditor
      Opens a directory. All property changes as well as entries adding/deletion can be applied to this directory.
      Specified by:
      openDir in interface ISVNEditor
      Parameters:
      path - a directory path relative to the root directory opened by openRoot()
      revision - the revision of the directory
      Throws:
      SVNException

    • changeDirProperty

      public void changeDirProperty(String name, SVNPropertyValue value) throws SVNException
      Description copied from interface: ISVNEditor
      Changes the value of a property of the currently opened/added directory.
      Specified by:
      changeDirProperty in interface ISVNEditor
      Parameters:
      name - the name of a property to be changed
      value - new property value
      Throws:
      SVNException
      See Also:

    • closeDir

      public void closeDir() throws SVNException
      Description copied from interface: ISVNEditor
      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.
      Specified by:
      closeDir in interface ISVNEditor
      Throws:
      SVNException

    • addFile

      public void addFile(String path, String copyFromPath, long copyFromRevision) throws SVNException
      Description copied from interface: ISVNEditor
      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.

      Specified by:
      addFile in interface ISVNEditor
      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:
      SVNException

    • openFile

      public void openFile(String path, long revision) throws SVNException
      Description copied from interface: ISVNEditor
      Opens a file. After it's opened, apply delta to its contents or change the file properties.
      Specified by:
      openFile in interface ISVNEditor
      Parameters:
      path - a file path relative to the root directory opened by openRoot()
      revision - the revision of the file
      Throws:
      SVNException

    • changeFileProperty

      public void changeFileProperty(String path, String propertyName, SVNPropertyValue propertyValue) throws SVNException
      Description copied from interface: ISVNEditor
      Changes the value of a property of the currently opened/added file.
      Specified by:
      changeFileProperty in interface ISVNEditor
      Parameters:
      path - file path relative to the root of this editor
      propertyName - property name
      propertyValue - property value
      Throws:
      SVNException

    • closeFile

      public void closeFile(String path, String expectedMd5Digest) throws SVNException
      Description copied from interface: ISVNEditor
      Closes the opened file fixing all properties and/or contents changes.
      Specified by:
      closeFile in interface ISVNEditor
      Parameters:
      path - a file path relative to the root directory opened by openRoot()
      expectedMd5Digest - an MD5 checksum for the modified file
      Throws:
      SVNException - if the calculated upon the actual changed contents checksum does not match the expected textChecksum

    • closeEdit

      public SVNCommitInfo closeEdit() throws SVNException
      Description copied from interface: ISVNEditor
      Closes this editor finalizing the whole operation the editor was used for. In a commit - sends collected data to commit a transaction.
      Specified by:
      closeEdit in interface ISVNEditor
      Returns:
      a committed revision information
      Throws:
      SVNException

    • abortEdit

      public void abortEdit() throws SVNException
      Description copied from interface: ISVNEditor
      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.

      Specified by:
      abortEdit in interface ISVNEditor
      Throws:
      SVNException

    • applyTextDelta

      public void applyTextDelta(String path, String baseChecksumDigest) throws SVNException
      Description copied from interface: ISVNDeltaConsumer
      Starts applying text delta(s) to an opened file.
      Specified by:
      applyTextDelta in interface ISVNDeltaConsumer
      Parameters:
      path - a file path relative to the edit root directory
      baseChecksumDigest - an MD5 checksum for the base file contents (before the file is changed)
      Throws:
      SVNException - if the calculated base file checksum didn't match the expected baseChecksum

    • textDeltaChunk

      public OutputStream textDeltaChunk(String path, SVNDiffWindow diffWindow) throws SVNException
      Description copied from interface: ISVNDeltaConsumer
      Collects a next delta chunk. The return type is nomore relevant and is left only for backward compatibility. So, the return value may be just null. Otherwise if it's not null, the stream will be immediately closed.

      If there are more than one windows for the file, this method is called several times.

      Specified by:
      textDeltaChunk in interface ISVNDeltaConsumer
      Parameters:
      path - a file path relative to the edit root directory
      diffWindow - a next diff window
      Returns:
      an output stream
      Throws:
      SVNException

    • textDeltaEnd

      public void textDeltaEnd(String path) throws SVNException
      Description copied from interface: ISVNDeltaConsumer
      Finalizes collecting text delta(s).
      Specified by:
      textDeltaEnd in interface ISVNDeltaConsumer
      Parameters:
      path - a file path relative to the edit root directory
      Throws:
      SVNException

    • getTargetRevision

      public long getTargetRevision()
      Specified by:
      getTargetRevision in interface ISVNUpdateEditor