| org.antmod.scm.ScmSystem
All known Subclasses: org.antmod.scm.impl.SvnSystemImpl, org.antmod.scm.impl.CvsSystemImpl,
| ScmSystem | | public interface ScmSystem (Code) | | Interface to be implemented by repository providers for access to
a Source Configuration Management system such as CVS or Subversion.
author:
Klaas Waslander |
| Method Summary | |
| public String | createBranchInTrunk(ScmVersion newBranchForModule)
| | public String | createTagInBranch(ScmVersion existingBranch, ScmVersion newTag)
| | public void | doAdd(File file, boolean recursive)
Add the given directory or file to this scm system. | | public void | doCheckout(String moduleName, File destDir, ScmVersion version, boolean reallyQuiet)
Checkout a module from this SCM repository into the given destination directory;
the destDir contains the module contents afterwards.
Parameters:
moduleName - The top-level module to be checked out from the SCM repository
Parameters:
destDir - The destination directory for the locally checked out module contents, usually you set this to a directory with the name equal to the moduleName
Parameters:
version - The module version you want to checkout. | | public void | doCheckoutOrUpdate(String moduleName, File destDir, ScmVersion version, boolean reallyQuiet)
Convenience method for doing a checkout only if needed, and otherwise
updating the existing checkout. | | public void | doCommit(File file, String message)
Commit the given file or a whole directory to CVS. | | public void | doExport(String moduleName, File destDir, ScmVersion version, boolean reallyQuiet)
| | public void | doMerge(File moduleDir, ScmVersion version)
Merge in changes made between current version of local module directory
and given version. | | public void | doUpdate(File file, ScmVersion version)
Update existing checkout locally to the given revision, or keep the same revision if null. | | public ScmDifference[] | getDifferences(ScmVersion version1, ScmVersion version2)
Get the changes between two versions of the same module. | | public String | getErrorOutput()
| | public ScmVersion | getLatestVersion(File moduleDir)
Get the latest version of a locally checked out module directory. | | public ScmVersion | getLocalVersion(File moduleDir)
| | public String | getRevisionNumber(File file)
Get the current revision number of the given file in SCM. | | public String | getStandardOutput()
| | public ScmUrl | getUrl()
Get the URL of the repository which this ScmSystem instance
is communicating with. | | public ScmVersion[] | getVersionsInBranch(File file, ScmVersion branch)
| | public boolean | isCheckoutDir(File directory)
Returns true if the given directory contains a checkout
of content from this ScmSystem. | | public boolean | isUpToDate(File checkoutDir)
Check whether the given checkout directory is up-to-date
when comparing it to the repository contents. | | void | setUrl(ScmUrl providerUrl)
Set the URL this ScmSystem instance should be talking with;
is only invoked from within this package. |
| doAdd | | public void doAdd(File file, boolean recursive)(Code) | | Add the given directory or file to this scm system.
If it is not a file within an already added directory structure, the file/directory
will be added to the root of this scm system.
Parameters:
file - The file/directory to be added
Parameters:
recursive - Whether to add any files under the directory recursively |
| doCheckout | | public void doCheckout(String moduleName, File destDir, ScmVersion version, boolean reallyQuiet)(Code) | | Checkout a module from this SCM repository into the given destination directory;
the destDir contains the module contents afterwards.
Parameters:
moduleName - The top-level module to be checked out from the SCM repository
Parameters:
destDir - The destination directory for the locally checked out module contents, usually you set this to a directory with the name equal to the moduleName
Parameters:
version - The module version you want to checkout.
Parameters:
reallyQuiet - Whether console output should be suppressed |
| doCheckoutOrUpdate | | public void doCheckoutOrUpdate(String moduleName, File destDir, ScmVersion version, boolean reallyQuiet)(Code) | | Convenience method for doing a checkout only if needed, and otherwise
updating the existing checkout.
Parameters:
packageName -
Parameters:
revision -
Parameters:
destDir -
Parameters:
reallyQuiet - |
| doCommit | | public void doCommit(File file, String message)(Code) | | Commit the given file or a whole directory to CVS.
Parameters:
file - |
| doMerge | | public void doMerge(File moduleDir, ScmVersion version)(Code) | | Merge in changes made between current version of local module directory
and given version.
Parameters:
moduleDir - The module directory which should receive the changes compared to the given version
Parameters:
version - The version containing the changes to be merged into the locally checked module directory |
| doUpdate | | public void doUpdate(File file, ScmVersion version)(Code) | | Update existing checkout locally to the given revision, or keep the same revision if null.
Parameters:
file - The directory or file to be updated
Parameters:
version - If null, revision of checkout is not changed |
| getDifferences | | public ScmDifference[] getDifferences(ScmVersion version1, ScmVersion version2)(Code) | | Get the changes between two versions of the same module.
Parameters:
version1 - The 'old' version to use as base
Parameters:
version2 - The 'new' version, which should be compared against the 'old' version The changes between the given versions. |
| getLatestVersion | | public ScmVersion getLatestVersion(File moduleDir)(Code) | | Get the latest version of a locally checked out module directory.
Note that if the local version is a tag, this does not work.
null If no latest version is found |
| getRevisionNumber | | public String getRevisionNumber(File file)(Code) | | Get the current revision number of the given file in SCM.
|
| getUrl | | public ScmUrl getUrl()(Code) | | Get the URL of the repository which this ScmSystem instance
is communicating with.
The ScmUrl of the repository which this ScmSystem instance is communicating with. |
| isCheckoutDir | | public boolean isCheckoutDir(File directory)(Code) | | Returns true if the given directory contains a checkout
of content from this ScmSystem.
Parameters:
directory - The directory which does or does not contain a checkout Whether the given directory contains a checkout |
| isUpToDate | | public boolean isUpToDate(File checkoutDir)(Code) | | Check whether the given checkout directory is up-to-date
when comparing it to the repository contents.
Parameters:
checkoutDir - The directory with locally checked out contents Whether the checkoutDir is up-to-date |
| setUrl | | void setUrl(ScmUrl providerUrl)(Code) | | Set the URL this ScmSystem instance should be talking with;
is only invoked from within this package.
Parameters:
providerUrl - The URL this ScmSystem instance should be connecting with |
|
|