co.codewizards.cloudstore.core.repo.local

Interface LocalRepoManagerFactory

All Known Implementing Classes:

LocalRepoManagerFactoryImpl

public interface LocalRepoManagerFactory

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LocalRepoManagerFactory.Helper

Method Summary

Methods

Modifier and Type	Method and Description
void	addLocalRepoManagerCloseListener(LocalRepoManagerCloseListener listener)
void	close()
LocalRepoManager	createLocalRepoManagerForExistingRepository(File localRoot) Creates a LocalRepoManager for the given localRoot.
LocalRepoManager	createLocalRepoManagerForNewRepository(File localRoot) Creates a LocalRepoManager for the given localRoot.
Set<File>	getLocalRoots()
void	removeLocalRepoManagerCloseListener(LocalRepoManagerCloseListener listener)

Method Detail

createLocalRepoManagerForExistingRepository

LocalRepoManager createLocalRepoManagerForExistingRepository(File localRoot)
                                                             throws LocalRepoManagerException

Creates a LocalRepoManager for the given localRoot.

Important: You must call LocalRepoManager.close(). Use a try-finally block or a similar construction to prevent resource leakage!

If there is already a LocalRepoManager implementation instance for this localRoot, the same instance is re-used in the background. If there is none, yet, it is implicitly instantiated and enlisted. However, this method always returns a new proxy instance! It never returns the same instance twice.

If localRoot is not an existing repository in the file system, one of the following exceptions is thrown:

• FileNotFoundException
• FileNoDirectoryException
• FileNoRepositoryException

Parameters:

localRoot - the root-directory of the repository. Must not be null. Can be relative or absolute.

Returns:

the LocalRepoManagerImpl for the given localRoot. Never null.

Throws:

LocalRepoManagerException - if the given localRoot does not denote the root-directory of an existing repository.

See Also:

createLocalRepoManagerForNewRepository(File)

createLocalRepoManagerForNewRepository

LocalRepoManager createLocalRepoManagerForNewRepository(File localRoot)
                                                        throws LocalRepoManagerException

Creates a LocalRepoManager for the given localRoot.

Important: You must call LocalRepoManager.close(). Use a try-finally block or a similar construction to prevent resource leakage!

This method turns an existing directory into a repository. If localRoot already is a repository, a FileAlreadyRepositoryException is thrown.

If localRoot is not an existing directory in the file system, one of the following exceptions is thrown:

• FileNotFoundException
• FileNoDirectoryException

Parameters:

localRoot - the directory which is turned into the repository's root. Must not be null. Can be relative or absolute.

Returns:

the LocalRepoManager for the given localRoot. Never null.

Throws:

LocalRepoManagerException - if the given localRoot does not denote an existing directory or if it is a directory inside an existing repository.

close

void close()

addLocalRepoManagerCloseListener

void addLocalRepoManagerCloseListener(LocalRepoManagerCloseListener listener)

removeLocalRepoManagerCloseListener

void removeLocalRepoManagerCloseListener(LocalRepoManagerCloseListener listener)

getLocalRoots

Set<File> getLocalRoots()