summaryrefslogtreecommitdiff
path: root/clformat/src/main
diff options
context:
space:
mode:
Diffstat (limited to 'clformat/src/main')
-rw-r--r--clformat/src/main/java/bjc/utils/ioutils/format/CLModifiers.java2
-rw-r--r--clformat/src/main/java/bjc/utils/ioutils/format/CLParameters.java25
-rw-r--r--clformat/src/main/java/bjc/utils/ioutils/format/CLPattern.java1
-rw-r--r--clformat/src/main/java/bjc/utils/ioutils/format/directives/ConditionalDirective.java4
-rw-r--r--clformat/src/main/java/bjc/utils/ioutils/format/directives/Edict.java1
-rw-r--r--clformat/src/main/java/bjc/utils/ioutils/format/directives/NumberDirective.java6
6 files changed, 25 insertions, 14 deletions
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/CLModifiers.java b/clformat/src/main/java/bjc/utils/ioutils/format/CLModifiers.java
index bcd3096..e2cb8b4 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/CLModifiers.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/CLModifiers.java
@@ -36,6 +36,8 @@ public class CLModifiers {
* The state of the colon mod.
* @param dollar
* The state of the dollar mod.
+ * @param star
+ * The state of the star mod.
*/
public CLModifiers(boolean at, boolean colon, boolean dollar, boolean star) {
atMod = at;
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/CLParameters.java b/clformat/src/main/java/bjc/utils/ioutils/format/CLParameters.java
index 1ac025b..aef8fbe 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/CLParameters.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/CLParameters.java
@@ -347,7 +347,7 @@ public class CLParameters {
/**
* Get a boolean-valued parameter.
*
- * @param params
+ * @param parms
* The format parameters to use.
*
* @param key
@@ -365,9 +365,9 @@ public class CLParameters {
* @return The boolean value for that parameter, or the default value if that
* parameter didn't exist.
*/
- public boolean getBoolean(Tape<Object> params, String key, String paramName,
+ public boolean getBoolean(Tape<Object> parms, String key, String paramName,
String directive, boolean def) {
- String bol = resolveKey(key).getValue(params);
+ String bol = resolveKey(key).getValue(parms);
if (!bol.equals("")) {
if (bol.matches(RX_TRUE))
@@ -386,7 +386,7 @@ public class CLParameters {
/**
* Get the string value for a parameter.
*
- * @param params
+ * @param parms
* The format parameters we're using.
*
* @param key
@@ -404,9 +404,9 @@ public class CLParameters {
* @return The string value of the parameter, or the default value if there is
* no parameter by that name.
*/
- public String getString(Tape<Object> params, String key, String paramName,
+ public String getString(Tape<Object> parms, String key, String paramName,
String directive, String def) {
- String vl = resolveKey(key).getValue(params);
+ String vl = resolveKey(key).getValue(parms);
// @NOTE 9/19/17
//
@@ -421,7 +421,7 @@ public class CLParameters {
/**
* Get the character value of a parameter.
*
- * @param params
+ * @param parms
* The format parameters to use.
*
* @param key
@@ -432,13 +432,14 @@ public class CLParameters {
*
* @param directive
* The directive the parameter is for.
+ * @param def The default value of the char.
*
* @return The character value of the parameter, or the default value if the
* parameter isn't specified.
*/
- public char getChar(Tape<Object> params, String key, String paramName,
+ public char getChar(Tape<Object> parms, String key, String paramName,
String directive, char def) {
- String param = resolveKey(key).getValue(params);
+ String param = resolveKey(key).getValue(parms);
if (!param.equals("")) {
if (param.length() == 1) {
@@ -461,7 +462,7 @@ public class CLParameters {
/**
* Get the integer value for a parameter.
*
- * @param params
+ * @param parms
* The format parameters we are using.
*
* @param key
@@ -479,9 +480,9 @@ public class CLParameters {
* @return The integer value of the parameter, or the default value if there is
* no parameter by that name.
*/
- public int getInt(Tape<Object> params, String key, String paramName, String directive,
+ public int getInt(Tape<Object> parms, String key, String paramName, String directive,
int def) {
- String param = resolveKey(key).getValue(params);
+ String param = resolveKey(key).getValue(parms);
if (!param.equals("")) {
try {
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/CLPattern.java b/clformat/src/main/java/bjc/utils/ioutils/format/CLPattern.java
index b3d7762..fd303d5 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/CLPattern.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/CLPattern.java
@@ -51,6 +51,7 @@ public class CLPattern {
*
* @param inp
* The string to parse directives from.
+ * @return A matcher for format directives in the string.
*/
public static Matcher getDirectiveMatcher(String inp) {
return pFormatDirective.matcher(inp);
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/directives/ConditionalDirective.java b/clformat/src/main/java/bjc/utils/ioutils/format/directives/ConditionalDirective.java
index c26a936..491d629 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/directives/ConditionalDirective.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/directives/ConditionalDirective.java
@@ -182,6 +182,10 @@ class ConditionalEdict implements Edict {
}
}
break;
+ default:
+ // IMPROVE Should probably handle this
+ // -- Ben Culkin, 4/14/2020
+ break;
}
} catch (DirectiveEscape dex) {
// Conditionals are transparent to iteration-escapes
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/directives/Edict.java b/clformat/src/main/java/bjc/utils/ioutils/format/directives/Edict.java
index 6cb0192..49ed4b1 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/directives/Edict.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/directives/Edict.java
@@ -15,6 +15,7 @@ public interface Edict {
*
* @param formCTX
* The state needed for this invocation.
+ * @throws IOException Thrown if an I/O error happens.
*/
public void format(FormatContext formCTX) throws IOException;
}
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/directives/NumberDirective.java b/clformat/src/main/java/bjc/utils/ioutils/format/directives/NumberDirective.java
index 9208b0e..c7d4ab6 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/directives/NumberDirective.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/directives/NumberDirective.java
@@ -19,9 +19,11 @@ public class NumberDirective extends GeneralNumberDirective {
* Create a new radix based number directive.
*
* @param argidx
- * The argument offset to use.
+ * The argument offset to use.
* @param radix
- * The radix of the number to use.
+ * The radix of the number to use.
+ * @param directive
+ * The character that marks this directive.
*/
public NumberDirective(int argidx, int radix, char directive) {
this.argidx = argidx;