diff --git a/src/main/java/com/nulabinc/zxcvbn/Matcher.java b/src/main/java/com/nulabinc/zxcvbn/Matcher.java index a4cb77b..29cc1bc 100644 --- a/src/main/java/com/nulabinc/zxcvbn/Matcher.java +++ b/src/main/java/com/nulabinc/zxcvbn/Matcher.java @@ -3,6 +3,16 @@ import com.nulabinc.zxcvbn.matchers.Match; import java.util.List; +/** + * Represents a matcher responsible for identifying patterns within passwords. + * + *

Implementations of this interface provide specific matching strategies to detect various + * patterns such as dictionary words, sequences, and spatial patterns. + * + * @deprecated This interface is deprecated. Use {@link com.nulabinc.zxcvbn.matchers.Matcher} + * instead. + */ +@Deprecated public interface Matcher { - public List execute(CharSequence password); + List execute(CharSequence password); } diff --git a/src/main/java/com/nulabinc/zxcvbn/matchers/BaseMatcher.java b/src/main/java/com/nulabinc/zxcvbn/matchers/BaseMatcher.java index 09a6c02..3812e3b 100644 --- a/src/main/java/com/nulabinc/zxcvbn/matchers/BaseMatcher.java +++ b/src/main/java/com/nulabinc/zxcvbn/matchers/BaseMatcher.java @@ -1,7 +1,6 @@ package com.nulabinc.zxcvbn.matchers; import com.nulabinc.zxcvbn.Context; -import com.nulabinc.zxcvbn.Matcher; import java.io.Serializable; import java.util.Collections; import java.util.Comparator; diff --git a/src/main/java/com/nulabinc/zxcvbn/matchers/Matcher.java b/src/main/java/com/nulabinc/zxcvbn/matchers/Matcher.java new file mode 100644 index 0000000..78dcc07 --- /dev/null +++ b/src/main/java/com/nulabinc/zxcvbn/matchers/Matcher.java @@ -0,0 +1,21 @@ +package com.nulabinc.zxcvbn.matchers; + +import java.util.List; + +/** + * Represents a matcher responsible for identifying patterns within passwords. + * + *

Implementations of this interface provide specific matching strategies to detect various + * patterns such as dictionary words, sequences, and spatial patterns. + * + * @see Match + */ +public interface Matcher { + /** + * Analyzes the given password and returns a list of detected patterns as {@link Match} objects. + * + * @param password the password to analyze for patterns. + * @return a list of matches identifying patterns found within the password. + */ + List execute(CharSequence password); +} diff --git a/src/main/java/com/nulabinc/zxcvbn/matchers/OmnibusMatcher.java b/src/main/java/com/nulabinc/zxcvbn/matchers/OmnibusMatcher.java index 9a52962..368466d 100644 --- a/src/main/java/com/nulabinc/zxcvbn/matchers/OmnibusMatcher.java +++ b/src/main/java/com/nulabinc/zxcvbn/matchers/OmnibusMatcher.java @@ -1,7 +1,6 @@ package com.nulabinc.zxcvbn.matchers; import com.nulabinc.zxcvbn.Context; -import com.nulabinc.zxcvbn.Matcher; import java.util.ArrayList; import java.util.HashMap; import java.util.List;