From 040870eced4dc3e273313b9ec2ce7bb88d9cc6a0 Mon Sep 17 00:00:00 2001
From: bjculkin <bjculkin@mix.wvu.edu>
Date: Mon, 12 Feb 2018 22:57:29 -0500
Subject: Commenting

---
 .../java/bjc/utils/parserutils/StringDescaper.java | 28 ++++++++++++++++++++++
 1 file changed, 28 insertions(+)

(limited to 'base/src/main/java/bjc/utils/parserutils/StringDescaper.java')

diff --git a/base/src/main/java/bjc/utils/parserutils/StringDescaper.java b/base/src/main/java/bjc/utils/parserutils/StringDescaper.java
index 59f4760..0beb7c8 100644
--- a/base/src/main/java/bjc/utils/parserutils/StringDescaper.java
+++ b/base/src/main/java/bjc/utils/parserutils/StringDescaper.java
@@ -12,6 +12,12 @@ import static java.util.Map.Entry;
 
 import static bjc.utils.PropertyDB.getRegex;
 
+/**
+ * Customizable string descaping.
+ * 
+ * @author EVE
+ *
+ */
 public class StringDescaper {
 	private Logger LOGGER = Logger.getLogger(StringDescaper.class.getName());
 
@@ -37,6 +43,9 @@ public class StringDescaper {
 	private Map<String, String>			literalEscapes;
 	private Map<Pattern, UnaryOperator<String>>	specialEscapes;
 
+	/**
+	 * Create a new string descaper.
+	 */
 	public StringDescaper() {
 		literalEscapes = new HashMap<>();
 		specialEscapes = new HashMap<>();
@@ -45,6 +54,14 @@ public class StringDescaper {
 		escapePatt = Pattern.compile(rEscapeString);
 	}
 
+	/**
+	 * Add a new literal string escape.
+	 * 
+	 * @param escape
+	 *        The escape to add.
+	 * @param val
+	 *        The value for the escape.
+	 */
 	public void addLiteralEscape(String escape, String val) {
 		if(literalEscapes.containsKey(escape)) {
 			LOGGER.warning(String.format("Shadowing literal escape '%s'\n", escape));
@@ -53,6 +70,14 @@ public class StringDescaper {
 		literalEscapes.put(escape, val);
 	}
 
+	/**
+	 * Create a new custom escape.
+	 * 
+	 * @param escape
+	 *        The escape to add.
+	 * @param val
+	 *        The implementation of the escape.
+	 */
 	public void addSpecialEscape(String escape, UnaryOperator<String> val) {
 		/*
 		 * Make sure this special escape is a valid regex.
@@ -77,6 +102,9 @@ public class StringDescaper {
 		specialEscapes.put(patt, val);
 	}
 
+	/**
+	 * Compile the escapes.
+	 */
 	public void compileEscapes() {
 		StringBuilder work = new StringBuilder();
 
-- 
cgit v1.2.3