cvs2svn_lib/svn_repository_delegate.py

   1 # (Be in -*- python -*- mode.)
   2 #
   3 # ====================================================================
   4 # Copyright (c) 2000-2008 CollabNet.  All rights reserved.
   5 #
   6 # This software is licensed as described in the file COPYING, which
   7 # you should have received as part of this distribution.  The terms
   8 # are also available at http://subversion.tigris.org/license-1.html.
   9 # If newer versions of this license are posted there, you may use a
  10 # newer version instead, at your option.
  11 #
  12 # This software consists of voluntary contributions made by many
  13 # individuals.  For exact contribution history, see the revision
  14 # history and logs, available at http://cvs2svn.tigris.org/.
  15 # ====================================================================
  16
  17 """This module contains the SVNRepositoryDelegate class."""
  18
  19
  20 class SVNRepositoryDelegate:
  21   """Abstract superclass for any delegate to SVNOutputOption.
  22
  23   Subclasses must implement all of the methods below.
  24
  25   For each method, a subclass implements, in its own way, the
  26   Subversion operation implied by the method's name.  For example, for
  27   the add_path method, the DumpstreamDelegate would write out a
  28   'Node-add:' command to a Subversion dumpfile, the StdoutDelegate
  29   would merely print that the path is being added to the repository,
  30   and the RepositoryDelegate would actually cause the path to be added
  31   to the Subversion repository that it is creating."""
  32
  33   def start_commit(self, revnum, revprops):
  34     """An SVN commit is starting.
  35
  36     Perform any actions needed to start an SVN commit with revision
  37     number REVNUM and revision properties REVPROPS."""
  38
  39     raise NotImplementedError()
  40
  41   def end_commit(self):
  42     """An SVN commit is ending."""
  43
  44     raise NotImplementedError()
  45
  46   def initialize_project(self, project):
  47     """Initialize PROJECT.
  48
  49     For Subversion, this means to create the trunk, branches, and tags
  50     directories for PROJECT."""
  51
  52     raise NotImplementedError()
  53
  54   def initialize_lod(self, lod):
  55     """Initialize LOD with no contents.
  56
  57     LOD is an instance of LineOfDevelopment.  It is also possible for
  58     an LOD to be created by copying from another LOD; such events are
  59     indicated via the copy_lod() callback."""
  60
  61     raise NotImplementedError()
  62
  63   def mkdir(self, lod, cvs_directory):
  64     """Create CVS_DIRECTORY within LOD.
  65
  66     LOD is a LineOfDevelopment; CVS_DIRECTORY is a CVSDirectory."""
  67
  68     raise NotImplementedError()
  69
  70   def add_path(self, cvs_rev):
  71     """Add the path corresponding to CVS_REV to the repository.
  72
  73     CVS_REV is a CVSRevisionAdd."""
  74
  75     raise NotImplementedError()
  76
  77   def change_path(self, cvs_rev):
  78     """Change the path corresponding to CVS_REV in the repository.
  79
  80     CVS_REV is a CVSRevisionChange."""
  81
  82     raise NotImplementedError()
  83
  84   def delete_lod(self, lod):
  85     """Delete LOD from the repository.
  86
  87     LOD is a LineOfDevelopment instance."""
  88
  89     raise NotImplementedError()
  90
  91   def delete_path(self, lod, cvs_path):
  92     """Delete CVS_PATH from LOD.
  93
  94     LOD is a LineOfDevelopment; CVS_PATH is a CVSPath."""
  95
  96     raise NotImplementedError()
  97
  98   def copy_lod(self, src_lod, dest_lod, src_revnum):
  99     """Copy SRC_LOD in SRC_REVNUM to DEST_LOD.
 100
 101     SRC_LOD and DEST_LOD are both LODs, and SRC_REVNUM is a subversion
 102     revision number (int)."""
 103
 104     raise NotImplementedError()
 105
 106   def copy_path(self, cvs_path, src_lod, dest_lod, src_revnum):
 107     """Copy CVS_PATH in SRC_LOD@SRC_REVNUM to DEST_LOD.
 108
 109     CVS_PATH is a CVSPath, SRC_LOD and DEST_LOD are LODs, and
 110     SRC_REVNUM is a subversion revision number (int)."""
 111
 112     raise NotImplementedError()
 113
 114   def finish(self):
 115     """All SVN revisions have been committed.
 116
 117     Perform any necessary cleanup."""
 118
 119     raise NotImplementedError()
 120
 121