diff options
Diffstat (limited to 'org.eclipse.jgit/src/org/eclipse/jgit/treewalk/filter/TreeFilter.java')
| -rw-r--r-- | org.eclipse.jgit/src/org/eclipse/jgit/treewalk/filter/TreeFilter.java | 43 |
1 files changed, 23 insertions, 20 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/filter/TreeFilter.java b/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/filter/TreeFilter.java index 2c2fb47463..f0a76324b2 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/filter/TreeFilter.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/filter/TreeFilter.java @@ -67,7 +67,8 @@ import org.eclipse.jgit.treewalk.WorkingTreeIterator; * <p> * <b>Path filters:</b> * <ul> - * <li>Matching pathname: {@link PathFilter}</li> + * <li>Matching pathname: + * {@link org.eclipse.jgit.treewalk.filter.PathFilter}</li> * </ul> * * <p> @@ -79,9 +80,9 @@ import org.eclipse.jgit.treewalk.WorkingTreeIterator; * <p> * <b>Boolean modifiers:</b> * <ul> - * <li>AND: {@link AndTreeFilter}</li> - * <li>OR: {@link OrTreeFilter}</li> - * <li>NOT: {@link NotTreeFilter}</li> + * <li>AND: {@link org.eclipse.jgit.treewalk.filter.AndTreeFilter}</li> + * <li>OR: {@link org.eclipse.jgit.treewalk.filter.OrTreeFilter}</li> + * <li>NOT: {@link org.eclipse.jgit.treewalk.filter.NotTreeFilter}</li> * </ul> */ public abstract class TreeFilter { @@ -173,24 +174,25 @@ public abstract class TreeFilter { * Determine if the current entry is interesting to report. * <p> * This method is consulted for subtree entries even if - * {@link TreeWalk#isRecursive()} is enabled. The consultation allows the - * filter to bypass subtree recursion on a case-by-case basis, even when - * recursion is enabled at the application level. + * {@link org.eclipse.jgit.treewalk.TreeWalk#isRecursive()} is enabled. The + * consultation allows the filter to bypass subtree recursion on a + * case-by-case basis, even when recursion is enabled at the application + * level. * * @param walker * the walker the filter needs to examine. * @return true if the current entry should be seen by the application; * false to hide the entry. - * @throws MissingObjectException + * @throws org.eclipse.jgit.errors.MissingObjectException * an object the filter needs to consult to determine its answer * does not exist in the Git repository the walker is operating * on. Filtering this current walker entry is impossible without * the object. - * @throws IncorrectObjectTypeException + * @throws org.eclipse.jgit.errors.IncorrectObjectTypeException * an object the filter needed to consult was not of the * expected object type. This usually indicates a corrupt * repository, as an object link is referencing the wrong type. - * @throws IOException + * @throws java.io.IOException * a loose object or pack file could not be read to obtain data * necessary for the filter to make its decision. */ @@ -203,19 +205,19 @@ public abstract class TreeFilter { * <p> * This method extends the result returned by {@link #include(TreeWalk)} * with a third option (-1), splitting the value true. This gives the - * application a possibility to distinguish between an exact match - * and the case when a subtree to the current entry might be a match. + * application a possibility to distinguish between an exact match and the + * case when a subtree to the current entry might be a match. * * @param walker * the walker the filter needs to examine. - * @return -1 if the current entry is a parent of the filter but no - * exact match has been made; 0 if the current entry should - * be seen by the application; 1 if it should be hidden. - * @throws MissingObjectException + * @return -1 if the current entry is a parent of the filter but no exact + * match has been made; 0 if the current entry should be seen by the + * application; 1 if it should be hidden. + * @throws org.eclipse.jgit.errors.MissingObjectException * as thrown by {@link #include(TreeWalk)} - * @throws IncorrectObjectTypeException + * @throws org.eclipse.jgit.errors.IncorrectObjectTypeException * as thrown by {@link #include(TreeWalk)} - * @throws IOException + * @throws java.io.IOException * as thrown by {@link #include(TreeWalk)} * @since 4.7 */ @@ -241,16 +243,17 @@ public abstract class TreeFilter { public abstract boolean shouldBeRecursive(); /** + * {@inheritDoc} + * * Clone this tree filter, including its parameters. * <p> * This is a deep clone. If this filter embeds objects or other filters it * must also clone those, to ensure the instances do not share mutable data. - * - * @return another copy of this filter, suitable for another thread. */ @Override public abstract TreeFilter clone(); + /** {@inheritDoc} */ @Override public String toString() { String n = getClass().getName(); |