Browse Source

LocalDiskRepositoryTestCase: Clarify semantics of repository creation methods

Several of the utility methods create a Repository without setting
the 'autoClose' flag, which means that the caller is responsible for
closing it. Update the Javadoc to explicitly mention this.

Change-Id: I2410dd8d230cd4519f756c38b17141d0daa6c314
Signed-off-by: David Pursehouse <david.pursehouse@gmail.com>
stable-5.4
David Pursehouse 6 years ago committed by Matthias Sohn
parent
commit
ee32ca226e
  1. 12
      org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/LocalDiskRepositoryTestCase.java

12
org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/LocalDiskRepositoryTestCase.java

@ -366,7 +366,9 @@ public abstract class LocalDiskRepositoryTestCase {
/**
* Creates a new empty bare repository.
*
* @return the newly created repository, opened for access
* @return the newly created bare repository, opened for access. The
* repository will not be closed in {@link #tearDown()}; the caller
* is responsible for closing it.
* @throws IOException
* the repository could not be created in the temporary area
*/
@ -377,7 +379,9 @@ public abstract class LocalDiskRepositoryTestCase {
/**
* Creates a new empty repository within a new empty working directory.
*
* @return the newly created repository, opened for access
* @return the newly created repository, opened for access. The repository
* will not be closed in {@link #tearDown()}; the caller is
* responsible for closing it.
* @throws IOException
* the repository could not be created in the temporary area
*/
@ -391,7 +395,9 @@ public abstract class LocalDiskRepositoryTestCase {
* @param bare
* true to create a bare repository; false to make a repository
* within its working directory
* @return the newly created repository, opened for access
* @return the newly created repository, opened for access. The repository
* will not be closed in {@link #tearDown()}; the caller is
* responsible for closing it.
* @throws IOException
* the repository could not be created in the temporary area
* @since 5.3

Loading…
Cancel
Save