This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-text.git
The following commit(s) were added to refs/heads/master by this push:
new d93427d6 Javadoc
d93427d6 is described below
commit d93427d61d225d3f8025ece09a75f49f4d2f9b82
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Jun 7 07:38:58 2026 -0400
Javadoc
---
.../text/translate/AggregateTranslator.java | 2 +-
.../text/translate/CharSequenceTranslator.java | 35 ++++++++++------------
.../text/translate/CodePointTranslator.java | 2 +-
.../commons/text/translate/CsvTranslators.java | 4 +--
.../text/translate/NumericEntityUnescaper.java | 2 +-
.../commons/text/translate/OctalUnescaper.java | 2 +-
.../translate/UnicodeUnpairedSurrogateRemover.java | 2 +-
7 files changed, 22 insertions(+), 27 deletions(-)
diff --git
a/src/main/java/org/apache/commons/text/translate/AggregateTranslator.java
b/src/main/java/org/apache/commons/text/translate/AggregateTranslator.java
index 576eccf5..ada5f2cc 100644
--- a/src/main/java/org/apache/commons/text/translate/AggregateTranslator.java
+++ b/src/main/java/org/apache/commons/text/translate/AggregateTranslator.java
@@ -37,7 +37,7 @@ public class AggregateTranslator extends
CharSequenceTranslator {
private final List<CharSequenceTranslator> translators = new ArrayList<>();
/**
- * Specify the translators to be used at creation time.
+ * Constructs a new instance with translators to be used at creation time.
*
* @param translators CharSequenceTranslator array to aggregate.
*/
diff --git
a/src/main/java/org/apache/commons/text/translate/CharSequenceTranslator.java
b/src/main/java/org/apache/commons/text/translate/CharSequenceTranslator.java
index 459aca73..6b0294dd 100644
---
a/src/main/java/org/apache/commons/text/translate/CharSequenceTranslator.java
+++
b/src/main/java/org/apache/commons/text/translate/CharSequenceTranslator.java
@@ -14,6 +14,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
package org.apache.commons.text.translate;
import java.io.IOException;
@@ -25,9 +26,8 @@ import java.util.Locale;
import org.apache.commons.lang3.Validate;
/**
- * An API for translating text.
- * Its core use is to escape and unescape text. Because escaping and unescaping
- * is completely contextual, the API does not present two separate signatures.
+ * An API for translating text. Its core use is to escape and unescape text.
Because escaping and unescaping is completely contextual, the API does not
present
+ * two separate signatures.
*
* @since 1.0
*/
@@ -39,8 +39,7 @@ public abstract class CharSequenceTranslator {
static final char[] HEX_DIGITS = { '0', '1', '2', '3', '4', '5', '6', '7',
'8', '9', 'A', 'B', 'C', 'D', 'E', 'F' };
/**
- * Returns an upper case hexadecimal {@code String} for the given
- * character.
+ * Returns an upper case hexadecimal {@code String} for the given
character.
*
* @param codePoint The code point to convert.
* @return An upper case hexadecimal {@code String}
@@ -57,7 +56,7 @@ public abstract class CharSequenceTranslator {
}
/**
- * Helper for non-Writer usage.
+ * Translates an input. This is intentionally final as its algorithm is
tightly coupled with the abstract method of this class.
*
* @param input CharSequence to be translated.
* @return String output of translation.
@@ -77,13 +76,12 @@ public abstract class CharSequenceTranslator {
}
/**
- * Translate a set of code points, represented by an int index into a
CharSequence,
- * into another set of code points. The number of code points consumed
must be returned,
- * and the only IOExceptions thrown must be from interacting with the
Writer so that
- * the top level API may reliably ignore StringWriter IOExceptions.
+ * Translates a set of code points, represented by an int index into a
CharSequence, into another set of code points. The number of code points
consumed
+ * must be returned, and the only IOExceptions thrown must be from
interacting with the Writer so that the top level API may reliably ignore
StringWriter
+ * IOExceptions.
*
- * @param input CharSequence that is being translated.
- * @param index int representing the current point of translation.
+ * @param input CharSequence that is being translated.
+ * @param index int representing the current point of translation.
* @param writer Writer to translate the text to.
* @return int count of code points consumed.
* @throws IOException if and only if the Writer produces an IOException.
@@ -91,10 +89,9 @@ public abstract class CharSequenceTranslator {
public abstract int translate(CharSequence input, int index, Writer
writer) throws IOException;
/**
- * Translate an input onto a Writer. This is intentionally final as its
algorithm is
- * tightly coupled with the abstract method of this class.
+ * Translates an input onto a Writer. This is intentionally final as its
algorithm is tightly coupled with the abstract method of this class.
*
- * @param input CharSequence that is being translated.
+ * @param input CharSequence that is being translated.
* @param writer Writer to translate the text to.
* @throws IOException if and only if the Writer produces an IOException.
*/
@@ -116,8 +113,8 @@ public abstract class CharSequenceTranslator {
if (Character.isHighSurrogate(c1) && pos < len) {
final char c2 = input.charAt(pos);
if (Character.isLowSurrogate(c2)) {
- writer.write(c2);
- pos++;
+ writer.write(c2);
+ pos++;
}
}
continue;
@@ -131,8 +128,7 @@ public abstract class CharSequenceTranslator {
}
/**
- * Helper method to create a merger of this translator with another set of
- * translators. Useful in customizing the standard functionality.
+ * Creates a merger of this translator with another set of translators.
Useful in customizing the standard functionality.
*
* @param translators CharSequenceTranslator array of translators to merge
with this one.
* @return CharSequenceTranslator merging this translator with the others.
@@ -143,5 +139,4 @@ public abstract class CharSequenceTranslator {
System.arraycopy(translators, 0, newArray, 1, translators.length);
return new AggregateTranslator(newArray);
}
-
}
diff --git
a/src/main/java/org/apache/commons/text/translate/CodePointTranslator.java
b/src/main/java/org/apache/commons/text/translate/CodePointTranslator.java
index 266f197e..e699193d 100644
--- a/src/main/java/org/apache/commons/text/translate/CodePointTranslator.java
+++ b/src/main/java/org/apache/commons/text/translate/CodePointTranslator.java
@@ -28,7 +28,7 @@ import java.io.Writer;
public abstract class CodePointTranslator extends CharSequenceTranslator {
/**
- * Construct a new instance.
+ * Constructs a new instance.
*/
public CodePointTranslator() {
// empty
diff --git
a/src/main/java/org/apache/commons/text/translate/CsvTranslators.java
b/src/main/java/org/apache/commons/text/translate/CsvTranslators.java
index c49255c0..73fc3928 100644
--- a/src/main/java/org/apache/commons/text/translate/CsvTranslators.java
+++ b/src/main/java/org/apache/commons/text/translate/CsvTranslators.java
@@ -40,7 +40,7 @@ public final class CsvTranslators {
public static class CsvEscaper extends SinglePassTranslator {
/**
- * Construct a new instance.
+ * Constructs a new instance.
*/
public CsvEscaper() {
// empty
@@ -66,7 +66,7 @@ public final class CsvTranslators {
public static class CsvUnescaper extends SinglePassTranslator {
/**
- * Construct a new instance.
+ * Constructs a new instance.
*/
public CsvUnescaper() {
// empty
diff --git
a/src/main/java/org/apache/commons/text/translate/NumericEntityUnescaper.java
b/src/main/java/org/apache/commons/text/translate/NumericEntityUnescaper.java
index 776dba25..76963b46 100644
---
a/src/main/java/org/apache/commons/text/translate/NumericEntityUnescaper.java
+++
b/src/main/java/org/apache/commons/text/translate/NumericEntityUnescaper.java
@@ -64,7 +64,7 @@ public class NumericEntityUnescaper extends
CharSequenceTranslator {
private final EnumSet<OPTION> options;
/**
- * Creates a UnicodeUnescaper.
+ * Constructs a new instance.
*
* The constructor takes a list of options, only one type of which is
currently available (whether to allow, error or ignore the semicolon on the end
of a
* numeric entity to being missing).
diff --git
a/src/main/java/org/apache/commons/text/translate/OctalUnescaper.java
b/src/main/java/org/apache/commons/text/translate/OctalUnescaper.java
index 2d6ecde6..2510f595 100644
--- a/src/main/java/org/apache/commons/text/translate/OctalUnescaper.java
+++ b/src/main/java/org/apache/commons/text/translate/OctalUnescaper.java
@@ -34,7 +34,7 @@ import org.apache.commons.lang3.CharUtils;
public class OctalUnescaper extends CharSequenceTranslator {
/**
- * Creates a new instance.
+ * Constructs a new instance.
*/
public OctalUnescaper() {
// empty
diff --git
a/src/main/java/org/apache/commons/text/translate/UnicodeUnpairedSurrogateRemover.java
b/src/main/java/org/apache/commons/text/translate/UnicodeUnpairedSurrogateRemover.java
index 022cf0a5..85c2ce6e 100644
---
a/src/main/java/org/apache/commons/text/translate/UnicodeUnpairedSurrogateRemover.java
+++
b/src/main/java/org/apache/commons/text/translate/UnicodeUnpairedSurrogateRemover.java
@@ -27,7 +27,7 @@ import java.io.Writer;
public class UnicodeUnpairedSurrogateRemover extends CodePointTranslator {
/**
- * Creates a new instance.
+ * Constructs a new instance.
*/
public UnicodeUnpairedSurrogateRemover() {
// empty
