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/01/04 20:27:25 UTC
(commons-text) 02/02: Javadoc
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-text.git
commit 0735a2159cbc1013cbff70a9ba8fd9c24e9022f4
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Jan 4 15:27:17 2026 -0500
Javadoc
Add an empty line before a Javadoc comment
---
src/main/java/org/apache/commons/text/StringEscapeUtils.java | 2 ++
src/main/java/org/apache/commons/text/diff/StringsComparator.java | 3 +++
.../org/apache/commons/text/lookup/JavaPlatformStringLookup.java | 5 +++++
src/main/java/org/apache/commons/text/translate/CsvTranslators.java | 4 ++++
.../java/org/apache/commons/text/translate/LookupTranslator.java | 3 +++
src/main/java/org/apache/commons/text/translate/UnicodeEscaper.java | 2 ++
.../apache/commons/text/jmh/LongestCommonSubsequencePerformance.java | 1 +
7 files changed, 20 insertions(+)
diff --git a/src/main/java/org/apache/commons/text/StringEscapeUtils.java b/src/main/java/org/apache/commons/text/StringEscapeUtils.java
index dc9d5440..700ca956 100644
--- a/src/main/java/org/apache/commons/text/StringEscapeUtils.java
+++ b/src/main/java/org/apache/commons/text/StringEscapeUtils.java
@@ -122,6 +122,7 @@ public class StringEscapeUtils {
return sb.toString();
}
}
+
/**
* Translator object for unescaping backslash escaped entries.
*/
@@ -323,6 +324,7 @@ public class StringEscapeUtils {
new LookupTranslator(EntityArrays.ISO8859_1_ESCAPE),
new LookupTranslator(EntityArrays.HTML40_EXTENDED_ESCAPE)
);
+
/**
* Translator object for escaping individual Comma Separated Values.
*
diff --git a/src/main/java/org/apache/commons/text/diff/StringsComparator.java b/src/main/java/org/apache/commons/text/diff/StringsComparator.java
index 9f9813a9..2f530650 100644
--- a/src/main/java/org/apache/commons/text/diff/StringsComparator.java
+++ b/src/main/java/org/apache/commons/text/diff/StringsComparator.java
@@ -106,14 +106,17 @@ public class StringsComparator {
return start;
}
}
+
/**
* First character sequence.
*/
private final String left;
+
/**
* Second character sequence.
*/
private final String right;
+
/**
* Temporary array.
*/
diff --git a/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java b/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java
index faf01ee9..2b280b98 100644
--- a/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java
@@ -66,14 +66,19 @@ final class JavaPlatformStringLookup extends AbstractStringLookup {
* Defines the singleton for this class.
*/
static final JavaPlatformStringLookup INSTANCE = new JavaPlatformStringLookup();
+
/** {@code hardware} key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
private static final String KEY_HARDWARE = "hardware";
+
/** {@code locale} key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
private static final String KEY_LOCALE = "locale";
+
/** {@code os} key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
private static final String KEY_OS = "os";
+
/** {@code runtime} key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
private static final String KEY_RUNTIME = "runtime";
+
/** {@code version} key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
private static final String KEY_VERSION = "version";
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 9a5f4671..b116e50e 100644
--- a/src/main/java/org/apache/commons/text/translate/CsvTranslators.java
+++ b/src/main/java/org/apache/commons/text/translate/CsvTranslators.java
@@ -59,6 +59,7 @@ public final class CsvTranslators {
}
}
}
+
/**
* Translator for unescaping escaped Comma Separated Value entries.
*/
@@ -90,10 +91,13 @@ public final class CsvTranslators {
}
}
}
+
/** Comma character. */
private static final char CSV_DELIMITER = ',';
+
/** Quote character. */
private static final char CSV_QUOTE = '"';
+
/** Quote character converted to string. */
private static final String CSV_QUOTE_STR = String.valueOf(CSV_QUOTE);
diff --git a/src/main/java/org/apache/commons/text/translate/LookupTranslator.java b/src/main/java/org/apache/commons/text/translate/LookupTranslator.java
index 931344c5..18f2f092 100644
--- a/src/main/java/org/apache/commons/text/translate/LookupTranslator.java
+++ b/src/main/java/org/apache/commons/text/translate/LookupTranslator.java
@@ -33,10 +33,13 @@ public class LookupTranslator extends CharSequenceTranslator {
/** The mapping to be used in translation. */
private final Map<String, String> lookupMap;
+
/** The first character of each key in the lookupMap. */
private final BitSet prefixSet;
+
/** The length of the shortest key in the lookupMap. */
private final int shortest;
+
/** The length of the longest key in the lookupMap. */
private final int longest;
diff --git a/src/main/java/org/apache/commons/text/translate/UnicodeEscaper.java b/src/main/java/org/apache/commons/text/translate/UnicodeEscaper.java
index a2e2c751..cea0dcbb 100644
--- a/src/main/java/org/apache/commons/text/translate/UnicodeEscaper.java
+++ b/src/main/java/org/apache/commons/text/translate/UnicodeEscaper.java
@@ -35,6 +35,7 @@ public class UnicodeEscaper extends CodePointTranslator {
public static UnicodeEscaper above(final int codePoint) {
return outsideOf(0, codePoint);
}
+
/**
* Constructs a {@code UnicodeEscaper} below the specified value (exclusive).
*
@@ -44,6 +45,7 @@ public class UnicodeEscaper extends CodePointTranslator {
public static UnicodeEscaper below(final int codePoint) {
return outsideOf(codePoint, Integer.MAX_VALUE);
}
+
/**
* Constructs a {@code UnicodeEscaper} between the specified values (inclusive).
*
diff --git a/src/test/java/org/apache/commons/text/jmh/LongestCommonSubsequencePerformance.java b/src/test/java/org/apache/commons/text/jmh/LongestCommonSubsequencePerformance.java
index 49d1318e..b7266165 100644
--- a/src/test/java/org/apache/commons/text/jmh/LongestCommonSubsequencePerformance.java
+++ b/src/test/java/org/apache/commons/text/jmh/LongestCommonSubsequencePerformance.java
@@ -49,6 +49,7 @@ import org.openjdk.jmh.annotations.Warmup;
@Measurement(iterations = 5, time = 1)
@Fork(value = 1, jvmArgs = {"-server", "-Xms512M", "-Xmx512M"})
public class LongestCommonSubsequencePerformance {
+
/**
* Older implementation of LongestCommonSubsequence.
* Code is copied from Apache Commons Text version 1.10.0-SNAPSHOT