diff options
author | Matthias Sohn <matthias.sohn@sap.com> | 2017-12-18 11:15:00 +0100 |
---|---|---|
committer | Matthias Sohn <matthias.sohn@sap.com> | 2017-12-18 13:19:07 +0100 |
commit | c281692c06ff0b5d3bcba77755e6aabfc45c5035 (patch) | |
tree | 9b4defceb142a4f0e1bd01d92aa8e5baf1174612 /org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheIterator.java | |
parent | 1463bb9b8774cbf4ef5318d630d5b48d6a99e8fa (diff) | |
download | jgit-c281692c06ff0b5d3bcba77755e6aabfc45c5035.tar.gz jgit-c281692c06ff0b5d3bcba77755e6aabfc45c5035.zip |
Fix javadoc in org.eclipse.jgit dircache package
Change-Id: Ib485eb217ac6be70519816f8cc0396931043a3d1
Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
Diffstat (limited to 'org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheIterator.java')
-rw-r--r-- | org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheIterator.java | 24 |
1 files changed, 19 insertions, 5 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheIterator.java b/org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheIterator.java index ad93f7213f..68521d3981 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheIterator.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheIterator.java @@ -61,7 +61,8 @@ import org.eclipse.jgit.treewalk.EmptyTreeIterator; import org.eclipse.jgit.util.RawParseUtils; /** - * Iterate a {@link DirCache} as part of a <code>TreeWalk</code>. + * Iterate a {@link org.eclipse.jgit.dircache.DirCache} as part of a + * <code>TreeWalk</code>. * <p> * This is an iterator to adapt a loaded <code>DirCache</code> instance (such as * read from an existing <code>.git/index</code> file) to the tree structure @@ -134,6 +135,7 @@ public class DirCacheIterator extends AbstractTreeIterator { parseEntry(); } + /** {@inheritDoc} */ @Override public AbstractTreeIterator createSubtreeIterator(final ObjectReader reader) throws IncorrectObjectTypeException, IOException { @@ -143,6 +145,7 @@ public class DirCacheIterator extends AbstractTreeIterator { return new DirCacheIterator(this, currentSubtree); } + /** {@inheritDoc} */ @Override public EmptyTreeIterator createEmptyTreeIterator() { final byte[] n = new byte[Math.max(pathLen + 1, DEFAULT_PATH_SIZE)]; @@ -151,6 +154,7 @@ public class DirCacheIterator extends AbstractTreeIterator { return new EmptyTreeIterator(this, n, pathLen + 1); } + /** {@inheritDoc} */ @Override public boolean hasId() { if (currentSubtree != null) @@ -158,6 +162,7 @@ public class DirCacheIterator extends AbstractTreeIterator { return currentEntry != null; } + /** {@inheritDoc} */ @Override public byte[] idBuffer() { if (currentSubtree != null) @@ -167,6 +172,7 @@ public class DirCacheIterator extends AbstractTreeIterator { return zeroid; } + /** {@inheritDoc} */ @Override public int idOffset() { if (currentSubtree != null) @@ -176,6 +182,7 @@ public class DirCacheIterator extends AbstractTreeIterator { return 0; } + /** {@inheritDoc} */ @Override public void reset() { if (!first()) { @@ -188,16 +195,19 @@ public class DirCacheIterator extends AbstractTreeIterator { } } + /** {@inheritDoc} */ @Override public boolean first() { return ptr == treeStart; } + /** {@inheritDoc} */ @Override public boolean eof() { return ptr == treeEnd; } + /** {@inheritDoc} */ @Override public void next(int delta) { while (--delta >= 0) { @@ -211,6 +221,7 @@ public class DirCacheIterator extends AbstractTreeIterator { } } + /** {@inheritDoc} */ @Override public void back(int delta) { while (--delta >= 0) { @@ -282,12 +293,15 @@ public class DirCacheIterator extends AbstractTreeIterator { } /** - * Retrieves the {@link AttributesNode} for the current entry. + * Retrieves the {@link org.eclipse.jgit.attributes.AttributesNode} for the + * current entry. * * @param reader - * {@link ObjectReader} used to parse the .gitattributes entry. - * @return {@link AttributesNode} for the current entry. - * @throws IOException + * {@link org.eclipse.jgit.lib.ObjectReader} used to parse the + * .gitattributes entry. + * @return {@link org.eclipse.jgit.attributes.AttributesNode} for the + * current entry. + * @throws java.io.IOException * @since 3.7 */ public AttributesNode getEntryAttributesNode(ObjectReader reader) |