diff --git a/pom.xml b/pom.xml index 458386f..c21eee1 100644 --- a/pom.xml +++ b/pom.xml @@ -1,4 +1,6 @@ - + 4.0.0 @@ -9,7 +11,7 @@ Aho-CoraSick algorithm for efficient string matching Java library for efficient string matching against a large set of keywords 2014 - http://ahocorasick.org + https://github.com/robert-bor/aho-corasick @@ -46,12 +48,17 @@ 42 - + Daniel Beck + neoSearch UG (haftungsbeschränkt) + + + Dave Jarvis + White Magic Software, Ltd. - 1.7 + 1.8 UTF-8 4.10 @@ -111,6 +118,9 @@ jar + + 8 + @@ -147,7 +157,7 @@ org.jacoco jacoco-maven-plugin - 0.7.7.201606060606 + 0.8.5 @@ -166,5 +176,4 @@ - diff --git a/src/main/java/org/ahocorasick/interval/Intervalable.java b/src/main/java/org/ahocorasick/interval/Intervalable.java index 0dd5f69..223309e 100644 --- a/src/main/java/org/ahocorasick/interval/Intervalable.java +++ b/src/main/java/org/ahocorasick/interval/Intervalable.java @@ -2,10 +2,10 @@ package org.ahocorasick.interval; public interface Intervalable extends Comparable { - public int getStart(); + int getStart(); - public int getEnd(); + int getEnd(); - public int size(); + int size(); } diff --git a/src/main/java/org/ahocorasick/trie/Payload.java b/src/main/java/org/ahocorasick/trie/Payload.java index 111a043..0fef5df 100644 --- a/src/main/java/org/ahocorasick/trie/Payload.java +++ b/src/main/java/org/ahocorasick/trie/Payload.java @@ -1,10 +1,9 @@ package org.ahocorasick.trie; /** - * Payload holds the matched keyword and some payload-data. + * Contains the matched keyword and some payload data. * * @author Daniel Beck - * * @param The type of the wrapped payload data. */ public class Payload implements Comparable> { diff --git a/src/main/java/org/ahocorasick/trie/PayloadEmit.java b/src/main/java/org/ahocorasick/trie/PayloadEmit.java index a456e61..e0fc036 100644 --- a/src/main/java/org/ahocorasick/trie/PayloadEmit.java +++ b/src/main/java/org/ahocorasick/trie/PayloadEmit.java @@ -4,11 +4,10 @@ import org.ahocorasick.interval.Interval; import org.ahocorasick.interval.Intervalable; /** - * PayloadEmit contains a matched term and its associated payload data. + * Contains a matched term and its associated payload data. * * @param Type of the wrapped payload-data. * @author Daniel Beck - * */ public class PayloadEmit extends Interval implements Intervalable { diff --git a/src/main/java/org/ahocorasick/trie/PayloadFragmentToken.java b/src/main/java/org/ahocorasick/trie/PayloadFragmentToken.java index b1809dd..d78312c 100644 --- a/src/main/java/org/ahocorasick/trie/PayloadFragmentToken.java +++ b/src/main/java/org/ahocorasick/trie/PayloadFragmentToken.java @@ -1,10 +1,11 @@ package org.ahocorasick.trie; /*** - * PayloadFragmentToken holds a text ("the fragment"). + * Container for a token ("the fragment") that can emit a type of payload. *

- * It does not matches a search term - so its isMatch-method - * returns always false. getEmits returns not Emits. + * This token indicates a matching search term was not found, so + * {@link #isMatch()} always returns {@code false}. + *

* * @author Daniel Beck * diff --git a/src/main/java/org/ahocorasick/trie/PayloadMatchToken.java b/src/main/java/org/ahocorasick/trie/PayloadMatchToken.java index ab7d8ac..0979c98 100644 --- a/src/main/java/org/ahocorasick/trie/PayloadMatchToken.java +++ b/src/main/java/org/ahocorasick/trie/PayloadMatchToken.java @@ -1,10 +1,11 @@ package org.ahocorasick.trie; /** - * PayloadMatchToken holds a text ("the fragment") an emits some output. + * Container for a token ("the fragment") that can emit a type of payload. *

- * It matches a search term - so its isMatch-method returns always - * true.. + * This token indicates a matching search term was found, so {@link #isMatch()} + * always returns {@code true}. + *

* * @author Daniel Beck * diff --git a/src/main/java/org/ahocorasick/trie/PayloadToken.java b/src/main/java/org/ahocorasick/trie/PayloadToken.java index d99873e..160aa7a 100644 --- a/src/main/java/org/ahocorasick/trie/PayloadToken.java +++ b/src/main/java/org/ahocorasick/trie/PayloadToken.java @@ -2,8 +2,8 @@ package org.ahocorasick.trie; /*** * PayloadToken holds a text ("the fragment") an emits some output. If - * isMatch returns true, the token matched a search term. - * + * {@link #isMatch()} returns {@code true}, the token matched a search term. + * * @author Daniel Beck * * @param The Type of the emitted payloads. @@ -20,8 +20,8 @@ public abstract class PayloadToken { } /** - * Return true if a search term matched. - * @return true if this is a match + * Return {@code true} if a search term matched. + * @return {@code true} if this is a match */ public abstract boolean isMatch(); diff --git a/src/main/java/org/ahocorasick/trie/PayloadTrie.java b/src/main/java/org/ahocorasick/trie/PayloadTrie.java index f8db80f..ac30f76 100644 --- a/src/main/java/org/ahocorasick/trie/PayloadTrie.java +++ b/src/main/java/org/ahocorasick/trie/PayloadTrie.java @@ -17,15 +17,16 @@ import org.ahocorasick.util.ListElementRemoval; import org.ahocorasick.util.ListElementRemoval.RemoveElementPredicate; /** - * A trie implementation, based on the Aho-Corasick white paper, Bell - * technologies: http://cr.yp.to/bib/1975/aho.pdf - *

+ * A trie implementation that carries a payload. See {@link Trie} for + * details on usage. * + *

* The payload trie adds the possibility to specify emitted payloads for each * added keyword. + *

* * @author Daniel Beck - * @param The type of the supplied of the payload + * @param The type of the supplied of the payload. */ public class PayloadTrie { diff --git a/src/main/java/org/ahocorasick/trie/Trie.java b/src/main/java/org/ahocorasick/trie/Trie.java index 340b725..cff2cfb 100644 --- a/src/main/java/org/ahocorasick/trie/Trie.java +++ b/src/main/java/org/ahocorasick/trie/Trie.java @@ -10,8 +10,8 @@ import org.ahocorasick.trie.handler.PayloadEmitDelegateHandler; import org.ahocorasick.trie.handler.StatefulEmitHandler; /** - * Based on the Aho-Corasick white paper, Bell technologies: - * http://cr.yp.to/bib/1975/aho.pdf + * Based on the Aho-Corasick white + * paper, from Bell technologies. * * @author Robert Bor */ diff --git a/src/main/java/org/ahocorasick/trie/handler/PayloadEmitDelegateHandler.java b/src/main/java/org/ahocorasick/trie/handler/PayloadEmitDelegateHandler.java index 3ec3a34..2d42552 100644 --- a/src/main/java/org/ahocorasick/trie/handler/PayloadEmitDelegateHandler.java +++ b/src/main/java/org/ahocorasick/trie/handler/PayloadEmitDelegateHandler.java @@ -4,7 +4,8 @@ import org.ahocorasick.trie.Emit; import org.ahocorasick.trie.PayloadEmit; /** - * Convenience wrapper class that delegates every method to a EmitHandler. + * Convenience wrapper class that delegates every method to an + * instance of {@link EmitHandler}. */ public class PayloadEmitDelegateHandler implements PayloadEmitHandler { diff --git a/src/main/java/org/ahocorasick/trie/handler/StatefulPayloadEmitDelegateHandler.java b/src/main/java/org/ahocorasick/trie/handler/StatefulPayloadEmitDelegateHandler.java index 395517b..1a8e1da 100644 --- a/src/main/java/org/ahocorasick/trie/handler/StatefulPayloadEmitDelegateHandler.java +++ b/src/main/java/org/ahocorasick/trie/handler/StatefulPayloadEmitDelegateHandler.java @@ -9,7 +9,7 @@ import org.ahocorasick.trie.PayloadEmit; /** * Convenience wrapper class that delegates every method to a - * StatefullPayloadEmitHandler. + * {@link StatefulPayloadEmitHandler}. */ public class StatefulPayloadEmitDelegateHandler implements StatefulPayloadEmitHandler {