summaryrefslogtreecommitdiff
path: root/BJC-Utils2/src/main/java/bjc/utils/parserutils/delims/RegexOpener.java
diff options
context:
space:
mode:
Diffstat (limited to 'BJC-Utils2/src/main/java/bjc/utils/parserutils/delims/RegexOpener.java')
-rw-r--r--BJC-Utils2/src/main/java/bjc/utils/parserutils/delims/RegexOpener.java19
1 files changed, 17 insertions, 2 deletions
diff --git a/BJC-Utils2/src/main/java/bjc/utils/parserutils/delims/RegexOpener.java b/BJC-Utils2/src/main/java/bjc/utils/parserutils/delims/RegexOpener.java
index c9965f2..7b4aac0 100644
--- a/BJC-Utils2/src/main/java/bjc/utils/parserutils/delims/RegexOpener.java
+++ b/BJC-Utils2/src/main/java/bjc/utils/parserutils/delims/RegexOpener.java
@@ -7,11 +7,26 @@ import java.util.function.Function;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
+/**
+ * A predicated opener for use with {@link RegexOpener}
+ *
+ * @author bjculkin
+ *
+ */
public class RegexOpener implements Function<String, IPair<String, String[]>> {
private String name;
private Pattern patt;
+ /**
+ * Create a new regex opener.
+ *
+ * @param groupName
+ * The name of the opened group.
+ *
+ * @param groupRegex
+ * The regex that matches the opener.
+ */
public RegexOpener(String groupName, String groupRegex) {
name = groupName;
@@ -22,12 +37,12 @@ public class RegexOpener implements Function<String, IPair<String, String[]>> {
public IPair<String, String[]> apply(String str) {
Matcher m = patt.matcher(str);
- if(m.matches()) {
+ if (m.matches()) {
int numGroups = m.groupCount();
String[] parms = new String[numGroups + 1];
- for(int i = 0; i <= numGroups; i++) {
+ for (int i = 0; i <= numGroups; i++) {
parms[i] = m.group(i);
}