You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2026/08/02 21:13:05 UTC
(commons-text) branch master updated: Javadoc
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 79083a00 Javadoc
79083a00 is described below
commit 79083a00a3c593592a42dd975b6e9ed27e35179a
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 2 17:12:59 2026 -0400
Javadoc
---
src/main/java/org/apache/commons/text/StrBuilder.java | 4 ++--
src/main/java/org/apache/commons/text/TextStringBuilder.java | 8 ++++----
.../org/apache/commons/text/translate/CharSequenceTranslator.java | 4 ++--
.../org/apache/commons/text/translate/CodePointTranslator.java | 2 +-
.../org/apache/commons/text/translate/SinglePassTranslator.java | 2 +-
src/test/java/org/apache/commons/text/StringEscapeUtilsTest.java | 2 +-
6 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/src/main/java/org/apache/commons/text/StrBuilder.java b/src/main/java/org/apache/commons/text/StrBuilder.java
index 063d26ec..37226c5b 100644
--- a/src/main/java/org/apache/commons/text/StrBuilder.java
+++ b/src/main/java/org/apache/commons/text/StrBuilder.java
@@ -1303,7 +1303,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
* </p>
*
* @param appendable The appendable to append data to.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
* @see #readFrom(Readable)
*/
public void appendTo(final Appendable appendable) throws IOException {
@@ -2430,7 +2430,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
*
* @param readable object to read from.
* @return The number of characters read.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
* @see #appendTo(Appendable)
*/
public int readFrom(final Readable readable) throws IOException {
diff --git a/src/main/java/org/apache/commons/text/TextStringBuilder.java b/src/main/java/org/apache/commons/text/TextStringBuilder.java
index 5cf467ac..91bd1758 100644
--- a/src/main/java/org/apache/commons/text/TextStringBuilder.java
+++ b/src/main/java/org/apache/commons/text/TextStringBuilder.java
@@ -1330,7 +1330,7 @@ public class TextStringBuilder implements CharSequence, Appendable, Serializable
* </p>
*
* @param appendable The appendable to append data to.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
* @see #readFrom(Readable)
*/
public void appendTo(final Appendable appendable) throws IOException {
@@ -2564,7 +2564,7 @@ public class TextStringBuilder implements CharSequence, Appendable, Serializable
*
* @param readable object to read from.
* @return The number of characters read.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
* @see #appendTo(Appendable)
*/
public int readFrom(final Readable readable) throws IOException {
@@ -2593,7 +2593,7 @@ public class TextStringBuilder implements CharSequence, Appendable, Serializable
*
* @param reader Reader to read.
* @return The number of characters read or -1 if we reached the end of stream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
* @see #appendTo(Appendable)
* @since 1.9
*/
@@ -2618,7 +2618,7 @@ public class TextStringBuilder implements CharSequence, Appendable, Serializable
* @param reader Reader to read.
* @param count The maximum characters to read, a value <= 0 returns 0.
* @return The number of characters read. If less than {@code count}, then we've reached the end-of-stream, or -1 if we reached the end of stream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
* @see #appendTo(Appendable)
* @since 1.9
*/
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 6b0294dd..8736066a 100644
--- a/src/main/java/org/apache/commons/text/translate/CharSequenceTranslator.java
+++ b/src/main/java/org/apache/commons/text/translate/CharSequenceTranslator.java
@@ -84,7 +84,7 @@ public abstract class CharSequenceTranslator {
* @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.
+ * @throws IOException Thrown if and only if the Writer produces an IOException.
*/
public abstract int translate(CharSequence input, int index, Writer writer) throws IOException;
@@ -93,7 +93,7 @@ public abstract class CharSequenceTranslator {
*
* @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.
+ * @throws IOException Thrown if and only if the Writer produces an IOException.
*/
public final void translate(final CharSequence input, final Writer writer) throws IOException {
Validate.isTrue(writer != null, "The Writer must not be null");
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 e699193d..61632932 100644
--- a/src/main/java/org/apache/commons/text/translate/CodePointTranslator.java
+++ b/src/main/java/org/apache/commons/text/translate/CodePointTranslator.java
@@ -47,7 +47,7 @@ public abstract class CodePointTranslator extends CharSequenceTranslator {
* @param codePoint int character input to translate.
* @param writer Writer to optionally push the translated output to.
* @return boolean as to whether translation occurred or not.
- * @throws IOException if and only if the Writer produces an IOException.
+ * @throws IOException Thrown if and only if the Writer produces an IOException.
*/
public abstract boolean translate(int codePoint, Writer writer) throws IOException;
diff --git a/src/main/java/org/apache/commons/text/translate/SinglePassTranslator.java b/src/main/java/org/apache/commons/text/translate/SinglePassTranslator.java
index 2fd4f671..da5ef974 100644
--- a/src/main/java/org/apache/commons/text/translate/SinglePassTranslator.java
+++ b/src/main/java/org/apache/commons/text/translate/SinglePassTranslator.java
@@ -57,7 +57,7 @@ abstract class SinglePassTranslator extends CharSequenceTranslator {
*
* @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.
+ * @throws IOException Thrown if and only if the Writer produces an IOException.
*/
abstract void translateWhole(CharSequence input, Writer writer) throws IOException;
}
diff --git a/src/test/java/org/apache/commons/text/StringEscapeUtilsTest.java b/src/test/java/org/apache/commons/text/StringEscapeUtilsTest.java
index c2ab95e8..e4bcf1a3 100644
--- a/src/test/java/org/apache/commons/text/StringEscapeUtilsTest.java
+++ b/src/test/java/org/apache/commons/text/StringEscapeUtilsTest.java
@@ -387,7 +387,7 @@ class StringEscapeUtilsTest {
/**
* Tests https://issues.apache.org/jira/browse/LANG-708
*
- * @throws IOException if an I/O error occurs
+ * @throws IOException Thrown if an I/O error occurs
*/
@Test
void testLang708() throws IOException {