Package org.omegat.core.team2

Interface IRemoteRepository2

All Known Implementing Classes:

FileRepository, GITRemoteRepository2, HTTPRemoteRepository, SVNRemoteRepository2

public interface IRemoteRepository2

Interface for any remote repository implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IRemoteRepository2.BadRepositoryException	Given repository does not exist on the remote machine
static class	IRemoteRepository2.NetworkException	Network problems.

Method Summary

Modifier and Type	Method	Description
void	addForCommit(java.lang.String path)	Add the specified file in preparation for commit (e.g.
void	addForDeletion(java.lang.String path)	remove the specified file in preparation for commit (e.g.
java.lang.String	commit(java.lang.String[] onVersions, java.lang.String comment)	Commit to repository after specified version, or after any version if 'null' specified.
java.lang.String	getFileVersion(java.lang.String file)	Get file version.
java.io.File	getLocalDirectory()	Return directory where this repo is in.
java.lang.String[]	getRecentlyDeletedFiles()	Returns a list of files or directories (empty or not) that have been deleted since the last call to this function, relative to the repository root that has been checked out.
void	init(RepositoryDefinition repo, java.io.File dir, ProjectTeamSettings teamSettings)	Initialize repository provider.
void	switchToVersion(java.lang.String version)

Method Detail

init

void init(RepositoryDefinition repo,
          java.io.File dir,
          ProjectTeamSettings teamSettings)
   throws java.lang.Exception

Initialize repository provider.

Parameters:

repo - repository description instance

dir - directory for store files

teamSettings - team settings object for project

Throws:

java.lang.Exception

getFileVersion

java.lang.String getFileVersion(java.lang.String file)
                         throws java.lang.Exception

Get file version.

Throws:

java.lang.Exception

switchToVersion

void switchToVersion(java.lang.String version)
              throws java.lang.Exception

Throws:

java.lang.Exception

addForCommit

void addForCommit(java.lang.String path)
           throws java.lang.Exception

Add the specified file in preparation for commit (e.g. git add, svn add).

Parameters:

path - The relative path of the item from the root of the repo (should not start with a /)

Throws:

java.lang.Exception

addForDeletion

void addForDeletion(java.lang.String path)
             throws java.lang.Exception

remove the specified file in preparation for commit (e.g. git rm, svn delete).

Parameters:

path - The relative path of the item from the root of the repo (should not start with a /)

Throws:

java.lang.Exception

getLocalDirectory

java.io.File getLocalDirectory()

Return directory where this repo is in.

Returns:

The directory, e.g. /path/to/omegatdir/.repositories/https_site.com_myproject.git

getRecentlyDeletedFiles

java.lang.String[] getRecentlyDeletedFiles()
                                    throws java.lang.Exception

Returns a list of files or directories (empty or not) that have been deleted since the last call to this function, relative to the repository root that has been checked out. If this function is called for the first time, it returns the empty list.

Returns:

Throws:

java.lang.Exception

commit

java.lang.String commit(java.lang.String[] onVersions,
                        java.lang.String comment)
                 throws java.lang.Exception

Commit to repository after specified version, or after any version if 'null' specified.

Parameters:

onVersions - if version defined, then commit must be just after this version. Otherwise(if remote repository was updated after rebase), commit shouldn't be processed and should return null. If version is null, then commit can be after any version, i.e. previous version shouldn't be checked. It can be several versions defined since glossary will be committed after project_save.tmx.

comment - comment for commit

Returns:

new version if commit was processed, or null if remote repository was updated by other user

Throws:

java.lang.Exception