- * The given path should point to the root of the dataset's directory. Assume that the given path to the dataset is - * `/home/alice/data/extraction-results`. Then, the structure of `extraction-results` should look as follows: - *
+ * The given path should point to the root of the dataset's directory. Assume that the given + * path to the dataset is `/home/alice/data/extraction-results`. Then, the structure of + * `extraction-results` should look as follows: + *+ *
* extraction-results/ - *|- log/
- *|- data/
- *|- SUCCESS_COMMITS.txt
+ *+ * |- log/ + *
+ *+ * |- data/ + *
+ *+ * |- SUCCESS_COMMITS.txt + *
* * @param p path to the root directory of the dataset * @return The fully-loaded dataset if loading is successful, otherwise an Exception. @@ -62,32 +73,43 @@ public boolean canLoad(final Path p) { @Override public ResultSPLCommit
objects are associated with their parents. Therefore, an Optional
is returned.
+ * Return the parents of this commit. As the dataset only contains the data about non-error
+ * commits, not all SPLCommit
objects are associated with their parents. Therefore,
+ * an Optional
is returned.
*
- * @return An Optional
containing the SPLCommit
objects of the parent commits, if there are any.
+ * @return An Optional
containing the SPLCommit
objects of the parent
+ * commits, if there are any.
*/
public Optional