Add missing @since tags and missing javadoc

Change-Id: I8575797127fc96abea8af56f019ca39f5897486f
Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
This commit is contained in:
Matthias Sohn 2015-11-26 00:32:37 +01:00
parent 5c8f2d8feb
commit 2cdc130dfc
6 changed files with 35 additions and 3 deletions

View File

@ -241,6 +241,17 @@ public static void deleteTrashFile(final Repository db,
FileUtils.delete(path); FileUtils.delete(path);
} }
/**
* @param db
* the repository
* @param link
* the path of the symbolic link to create
* @param target
* the target of the symbolic link
* @return the path to the symbolic link
* @throws Exception
* @since 4.2
*/
public static Path writeLink(Repository db, String link, public static Path writeLink(Repository db, String link,
String target) throws Exception { String target) throws Exception {
return FileUtils.createSymLink(new File(db.getWorkTree(), link), return FileUtils.createSymLink(new File(db.getWorkTree(), link),

View File

@ -91,7 +91,10 @@ public abstract class LocalDiskRepositoryTestCase {
/** A fake (but stable) identity for committer fields in the test. */ /** A fake (but stable) identity for committer fields in the test. */
protected PersonIdent committer; protected PersonIdent committer;
/** A {@link SystemReader} used to coordinate time, envars, etc. */ /**
* A {@link SystemReader} used to coordinate time, envars, etc.
* @since 4.2
*/
protected MockSystemReader mockSystemReader; protected MockSystemReader mockSystemReader;
private final List<Repository> toClose = new ArrayList<Repository>(); private final List<Repository> toClose = new ArrayList<Repository>();

View File

@ -151,6 +151,7 @@ public long getCurrentTime() {
* *
* @param secDelta * @param secDelta
* number of seconds to add to the current time. * number of seconds to add to the current time.
* @since 4.2
*/ */
public void tick(final int secDelta) { public void tick(final int secDelta) {
now += secDelta * 1000L; now += secDelta * 1000L;

View File

@ -108,6 +108,17 @@ protected File writeTrashFile(final String name, final String data)
return JGitTestUtil.writeTrashFile(db, name, data); return JGitTestUtil.writeTrashFile(db, name, data);
} }
/**
* Create a symbolic link
*
* @param link
* the path of the symbolic link to create
* @param target
* the target of the symbolic link
* @return the path to the symbolic link
* @throws Exception
* @since 4.2
*/
protected Path writeLink(final String link, final String target) protected Path writeLink(final String link, final String target)
throws Exception { throws Exception {
return JGitTestUtil.writeLink(db, link, target); return JGitTestUtil.writeLink(db, link, target);

View File

@ -175,6 +175,7 @@ public TestRepository(R db, RevWalk rw) throws IOException {
* the MockSystemReader to use for clock and other system * the MockSystemReader to use for clock and other system
* operations. * operations.
* @throws IOException * @throws IOException
* @since 4.2
*/ */
public TestRepository(R db, RevWalk rw, MockSystemReader reader) public TestRepository(R db, RevWalk rw, MockSystemReader reader)
throws IOException { throws IOException {
@ -203,7 +204,10 @@ public Git git() {
return git; return git;
} }
/** @return current date. */ /**
* @return current date.
* @since 4.2
*/
public Date getDate() { public Date getDate() {
return new Date(mockSystemReader.getCurrentTime()); return new Date(mockSystemReader.getCurrentTime());
} }

View File

@ -398,8 +398,10 @@ public static void createNewFile(File f) throws IOException {
* Create a symbolic link * Create a symbolic link
* *
* @param path * @param path
* the path of the symbolic link to create
* @param target * @param target
* @return path to the created link * the target of the symbolic link
* @return the path to the symbolic link
* @throws IOException * @throws IOException
* @since 4.2 * @since 4.2
*/ */