diff --git a/src/main/java/org/ahocorasick/interval/Interval.java b/src/main/java/org/ahocorasick/interval/Interval.java index e3b0012..26ffac9 100644 --- a/src/main/java/org/ahocorasick/interval/Interval.java +++ b/src/main/java/org/ahocorasick/interval/Interval.java @@ -50,7 +50,7 @@ public class Interval implements Intervalable { * Answers whether the given interval overlaps this interval * instance. * - * @param other + * @param other the other interval to check for overlap * @return true The intervals overlap. */ public boolean overlapsWith(final Interval other) { diff --git a/src/main/java/org/ahocorasick/trie/PayloadState.java b/src/main/java/org/ahocorasick/trie/PayloadState.java index effc49d..f7e3ee3 100644 --- a/src/main/java/org/ahocorasick/trie/PayloadState.java +++ b/src/main/java/org/ahocorasick/trie/PayloadState.java @@ -6,7 +6,6 @@ import java.util.*; *

* A state has various important tasks it must attend to: *

- *

*

*

- *

* The root state is special in the sense that it has no failure state; it * cannot fail. If it 'fails' it will still parse the next character and start * from the root node. This ensures that the algorithm always runs. All other @@ -109,7 +107,7 @@ public class PayloadState { /** * Adds a payload to be emitted for this state. * - * @param emit Payload to be emitted. + * @param payload to be emitted. */ public void addEmit(Payload payload) { if (this.emits == null) { diff --git a/src/main/java/org/ahocorasick/trie/PayloadToken.java b/src/main/java/org/ahocorasick/trie/PayloadToken.java index 4350e75..d99873e 100644 --- a/src/main/java/org/ahocorasick/trie/PayloadToken.java +++ b/src/main/java/org/ahocorasick/trie/PayloadToken.java @@ -21,8 +21,12 @@ public abstract class PayloadToken { /** * Return true if a search term matched. + * @return true if this is a match */ public abstract boolean isMatch(); + /** + * @return the payload + */ public abstract PayloadEmit getEmit(); } diff --git a/src/main/java/org/ahocorasick/trie/PayloadTrie.java b/src/main/java/org/ahocorasick/trie/PayloadTrie.java index 19db935..f8db80f 100644 --- a/src/main/java/org/ahocorasick/trie/PayloadTrie.java +++ b/src/main/java/org/ahocorasick/trie/PayloadTrie.java @@ -83,6 +83,7 @@ public class PayloadTrie { * Tokenizes the specified text and returns the emitted outputs. * * @param text The text to tokenize. + * @return the emitted outputs */ public Collection> tokenize(final String text) { final Collection> tokens = new ArrayList<>(); @@ -158,7 +159,7 @@ public class PayloadTrie { * Returns true if the text contains contains one of the search terms. Else, * returns false. * - * @param Text Specified text. + * @param text Specified text. * @return true if the text contains one of the search terms. Else, returns * false. */ @@ -172,9 +173,7 @@ public class PayloadTrie { * * @param text The character sequence to tokenize. * @param emitHandler The emit handler that will be used to parse the text. - * @return A collection of emits. */ - public void parseText(final CharSequence text, final PayloadEmitHandler emitHandler) { PayloadState currentState = getRootState(); @@ -348,6 +347,7 @@ public class PayloadTrie { /** * Provides a fluent interface for constructing Trie instances with payloads. + * @param The type of the emitted payload. * * @return The builder used to configure its Trie. */ @@ -412,6 +412,7 @@ public class PayloadTrie { * Adds a keyword and a payload to the Trie's list of text search keywords. * * @param keyword The keyword to add to the list. + * @param payload the payload to add * @return This builder. * @throws NullPointerException if the keyword is null. */ diff --git a/src/main/java/org/ahocorasick/trie/State.java b/src/main/java/org/ahocorasick/trie/State.java index e5d763a..c1e8d7c 100644 --- a/src/main/java/org/ahocorasick/trie/State.java +++ b/src/main/java/org/ahocorasick/trie/State.java @@ -6,7 +6,6 @@ import java.util.*; *

* A state has various important tasks it must attend to: *

- *

*

*

- *

* The root state is special in the sense that it has no failure state; it cannot fail. If it 'fails' * it will still parse the next character and start from the root node. This ensures that the algorithm * always runs. All other states always have a fail state. diff --git a/src/main/java/org/ahocorasick/util/ListElementRemoval.java b/src/main/java/org/ahocorasick/util/ListElementRemoval.java index ac64806..9ca184f 100644 --- a/src/main/java/org/ahocorasick/util/ListElementRemoval.java +++ b/src/main/java/org/ahocorasick/util/ListElementRemoval.java @@ -32,8 +32,9 @@ public class ListElementRemoval { /** * Removes all elements from the list matching the given predicate. * - * @param list - * @param predicate + * @param list the list from which to remove + * @param predicate to test for removal + * @param type of list */ public static void removeIf(final List list, final RemoveElementPredicate predicate) { final List newList = new ArrayList<>(list.size());