summaryrefslogtreecommitdiff
path: root/base/src/main/java/bjc/utils/parserutils/defines
diff options
context:
space:
mode:
authorBenjamin J. Culkin <bjculkin@mix.wvu.edu>2018-02-13 20:52:37 -0400
committerBenjamin J. Culkin <bjculkin@mix.wvu.edu>2018-02-13 20:52:37 -0400
commit2d8f0aba5565b292f17695afd276143a4f71c72b (patch)
tree2e855252038af0b15275958b64caaee9e72f8847 /base/src/main/java/bjc/utils/parserutils/defines
parentcb45a62d8629e079ae403489efab392d7208cb62 (diff)
Update
Diffstat (limited to 'base/src/main/java/bjc/utils/parserutils/defines')
-rw-r--r--base/src/main/java/bjc/utils/parserutils/defines/IteratedDefine.java7
-rw-r--r--base/src/main/java/bjc/utils/parserutils/defines/SimpleDefine.java11
2 files changed, 8 insertions, 10 deletions
diff --git a/base/src/main/java/bjc/utils/parserutils/defines/IteratedDefine.java b/base/src/main/java/bjc/utils/parserutils/defines/IteratedDefine.java
index 83ef8a8..6d1ed64 100644
--- a/base/src/main/java/bjc/utils/parserutils/defines/IteratedDefine.java
+++ b/base/src/main/java/bjc/utils/parserutils/defines/IteratedDefine.java
@@ -9,10 +9,9 @@ import java.util.regex.Pattern;
import bjc.utils.data.CircularIterator;
/**
- * A define that has a set of replacements to use.
- *
- * @author EVE
+ * An iterated find/replace, using a circular assortment of replacements.
*
+ * @author Ben Culkin
*/
public class IteratedDefine implements UnaryOperator<String> {
private Pattern patt;
@@ -28,7 +27,7 @@ public class IteratedDefine implements UnaryOperator<String> {
* Whether or not to loop through the list of replacers, or just
* repeat the last one.
* @param replacers
- * The set of replacers to use.
+ * The set of replacement strings to use.
*/
public IteratedDefine(Pattern pattern, boolean circular, String... replacers) {
patt = pattern;
diff --git a/base/src/main/java/bjc/utils/parserutils/defines/SimpleDefine.java b/base/src/main/java/bjc/utils/parserutils/defines/SimpleDefine.java
index d42f7d8..c3496a8 100644
--- a/base/src/main/java/bjc/utils/parserutils/defines/SimpleDefine.java
+++ b/base/src/main/java/bjc/utils/parserutils/defines/SimpleDefine.java
@@ -5,10 +5,9 @@ import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
- * A simple match-and-replace operation on strings.
- *
- * @author EVE
+ * A simple implementation of a find/replace operator on a string.
*
+ * @author Ben Culkin
*/
public class SimpleDefine implements UnaryOperator<String> {
private Pattern patt;
@@ -16,11 +15,11 @@ public class SimpleDefine implements UnaryOperator<String> {
/**
* Create a new simple define.
- *
+ *
* @param pattern
- * The pattern to look for.
+ * The pattern to match against.
* @param replace
- * The thing to replace it with.
+ * The text to use as a replacement.
*/
public SimpleDefine(Pattern pattern, String replace) {
patt = pattern;