reftable: clarify that LogCursor may return a null ReflogEntry

Change-Id: I1a4d5c262cd196dca37876aec00bb974a45e9fcd
Signed-off-by: Han-Wen Nienhuys <hanwen@google.com>
This commit is contained in:
Han-Wen Nienhuys 2020-01-29 18:55:43 +01:00
parent 75a80c5d3c
commit 0bf2564433
1 changed files with 3 additions and 1 deletions

View File

@ -45,6 +45,7 @@
import java.io.IOException; import java.io.IOException;
import org.eclipse.jgit.annotations.Nullable;
import org.eclipse.jgit.lib.ReflogEntry; import org.eclipse.jgit.lib.ReflogEntry;
/** /**
@ -78,8 +79,9 @@ public abstract class LogCursor implements AutoCloseable {
/** /**
* Get current log entry. * Get current log entry.
* *
* @return current log entry. * @return current log entry. Maybe null if we are producing deletions.
*/ */
@Nullable
public abstract ReflogEntry getReflogEntry(); public abstract ReflogEntry getReflogEntry();
/** {@inheritDoc} */ /** {@inheritDoc} */