Skip to content

[common] Replace commons StringUtils usages with Paimon StringUtils #7603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
leaves12138 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[common] Replace commons StringUtils usages with Paimon StringUtils #7603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 106 additions & 0 deletions paimon-api/src/main/java/org/apache/paimon/utils/StringUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,112 @@ public static boolean isNotEmpty(CharSequence cs) {
return !isEmpty(cs);
}

public static boolean isBlank(final CharSequence cs) {
if (isEmpty(cs)) {
return true;
}

for (int i = 0; i < cs.length(); i++) {
if (!Character.isWhitespace(cs.charAt(i))) {
return false;
}
}
return true;
}

public static boolean equals(final CharSequence cs1, final CharSequence cs2) {
if (cs1 == cs2) {
return true;
}
if (cs1 == null || cs2 == null || cs1.length() != cs2.length()) {
return false;
}

for (int i = 0; i < cs1.length(); i++) {
if (cs1.charAt(i) != cs2.charAt(i)) {
return false;
}
}
return true;
}

public static boolean startsWith(final CharSequence str, final CharSequence prefix) {
if (str == prefix) {
return true;
}
if (str == null || prefix == null) {
return false;
}

return str.toString().startsWith(prefix.toString());
}

public static boolean endsWith(final CharSequence str, final CharSequence suffix) {
if (str == suffix) {
return true;
}
if (str == null || suffix == null) {
return false;
}

return str.toString().endsWith(suffix.toString());
}

public static String substringBeforeLast(final String str, final String separator) {
if (isEmpty(str) || isEmpty(separator)) {
return str;
}

int pos = str.lastIndexOf(separator);
if (pos == INDEX_NOT_FOUND) {
return str;
}

return str.substring(0, pos);
}

public static String substringAfterLast(final String str, final String separator) {
if (isEmpty(str)) {
return str;
}
if (isEmpty(separator)) {
return EMPTY;
}

int pos = str.lastIndexOf(separator);
if (pos == INDEX_NOT_FOUND || pos == str.length() - separator.length()) {
return EMPTY;
}

return str.substring(pos + separator.length());
}

public static String stripEnd(final String str, final String stripChars) {
if (isEmpty(str)) {
return str;
}

int end = str.length();
if (stripChars == null) {
while (end != 0 && Character.isWhitespace(str.charAt(end - 1))) {
end--;
}
} else if (stripChars.isEmpty()) {
return str;
} else {
while (end != 0 && stripChars.indexOf(str.charAt(end - 1)) != INDEX_NOT_FOUND) {
end--;
}
}

return str.substring(0, end);
}

public static String trimToNull(final String str) {
String trimmed = trim(str);
return isEmpty(trimmed) ? null : trimmed;
}

public static String randomNumericString(int len) {
StringBuilder builder = new StringBuilder();
ThreadLocalRandom rnd = ThreadLocalRandom.current();
Expand Down
2 changes: 1 addition & 1 deletion ...enchmark/src/main/java/org/apache/paimon/benchmark/metric/cpu/ProcfsBasedProcessTree.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
import org.apache.commons.io.filefilter.DirectoryFileFilter;
import org.apache.commons.io.filefilter.RegexFileFilter;
import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.paimon.utils.StringUtils;

import java.io.BufferedReader;
import java.io.File;
Expand Down
3 changes: 2 additions & 1 deletion ...enchmark/paimon-micro-benchmarks/src/test/java/org/apache/paimon/benchmark/Benchmark.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@

package org.apache.paimon.benchmark;

import org.apache.paimon.shade.org.apache.commons.lang3.StringUtils;
import org.apache.paimon.utils.StringUtils;

import org.apache.paimon.shade.org.apache.commons.lang3.SystemUtils;

import java.io.BufferedReader;
Expand Down
50 changes: 50 additions & 0 deletions paimon-common/src/test/java/org/apache/paimon/utils/StringUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,56 @@ void testNonEmptyStringBuilder() {
}
}

@Nested
class CommonsCompatibilityTests {

@Test
void testIsBlank() {
assertThat(StringUtils.isBlank(null)).isTrue();
assertThat(StringUtils.isBlank("")).isTrue();
assertThat(StringUtils.isBlank(" \t")).isTrue();
assertThat(StringUtils.isBlank("paimon")).isFalse();
}

@Test
void testEquals() {
assertThat(StringUtils.equals(null, null)).isTrue();
assertThat(StringUtils.equals(null, "paimon")).isFalse();
assertThat(StringUtils.equals("paimon", "paimon")).isTrue();
assertThat(StringUtils.equals("paimon", "Paimon")).isFalse();
}

@Test
void testStartsWithAndEndsWith() {
assertThat(StringUtils.startsWith("manifest-1", "manifest")).isTrue();
assertThat(StringUtils.startsWith(null, "manifest")).isFalse();
assertThat(StringUtils.endsWith("part-0.parquet", ".parquet")).isTrue();
assertThat(StringUtils.endsWith("part-0.orc", ".parquet")).isFalse();
}

@Test
void testSubstringBeforeAndAfterLast() {
assertThat(StringUtils.substringBeforeLast("a/b/c", "/")).isEqualTo("a/b");
assertThat(StringUtils.substringBeforeLast("abc", "/")).isEqualTo("abc");
assertThat(StringUtils.substringAfterLast("a/b/c", "/")).isEqualTo("c");
assertThat(StringUtils.substringAfterLast("abc/", "/")).isEmpty();
}

@Test
void testStripEnd() {
assertThat(StringUtils.stripEnd("cpu\n", null)).isEqualTo("cpu");
assertThat(StringUtils.stripEnd("abccc", "c")).isEqualTo("ab");
assertThat(StringUtils.stripEnd("abc", "")).isEqualTo("abc");
}

@Test
void testTrimToNull() {
assertThat(StringUtils.trimToNull(null)).isNull();
assertThat(StringUtils.trimToNull(" ")).isNull();
assertThat(StringUtils.trimToNull(" paimon ")).isEqualTo("paimon");
}
}

@Nested
class RandomNumericStringTests {

Expand Down
3 changes: 1 addition & 2 deletions paimon-core/src/main/java/org/apache/paimon/catalog/TableQueryAuthResult.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@
import org.apache.paimon.types.RowType;
import org.apache.paimon.utils.InternalRowUtils;
import org.apache.paimon.utils.JsonSerdeUtil;

import org.apache.paimon.shade.org.apache.commons.lang3.StringUtils;
import org.apache.paimon.utils.StringUtils;

import javax.annotation.Nullable;

Expand Down
3 changes: 1 addition & 2 deletions paimon-core/src/main/java/org/apache/paimon/rest/RESTCatalog.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,12 @@
import org.apache.paimon.table.system.SystemTableLoader;
import org.apache.paimon.utils.Pair;
import org.apache.paimon.utils.SnapshotNotExistException;
import org.apache.paimon.utils.StringUtils;
import org.apache.paimon.view.View;
import org.apache.paimon.view.ViewChange;
import org.apache.paimon.view.ViewImpl;
import org.apache.paimon.view.ViewSchema;

import org.apache.paimon.shade.org.apache.commons.lang3.StringUtils;

import javax.annotation.Nullable;

import java.io.IOException;
Expand Down
2 changes: 1 addition & 1 deletion paimon-core/src/test/java/org/apache/paimon/rest/RESTCatalogServer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@
import org.apache.paimon.utils.LazyField;
import org.apache.paimon.utils.Pair;
import org.apache.paimon.utils.SnapshotManager;
import org.apache.paimon.utils.StringUtils;
import org.apache.paimon.utils.TagManager;
import org.apache.paimon.utils.TimeUtils;
import org.apache.paimon.view.View;
Expand All @@ -120,7 +121,6 @@

import org.apache.paimon.shade.guava30.com.google.common.collect.ImmutableMap;
import org.apache.paimon.shade.jackson2.com.fasterxml.jackson.core.JsonProcessingException;
import org.apache.paimon.shade.org.apache.commons.lang3.StringUtils;

import okhttp3.mockwebserver.Dispatcher;
import okhttp3.mockwebserver.MockResponse;
Expand Down
2 changes: 1 addition & 1 deletion paimon-core/src/test/java/org/apache/paimon/rest/RESTCatalogTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,14 +90,14 @@
import org.apache.paimon.types.DataTypes;
import org.apache.paimon.utils.SnapshotManager;
import org.apache.paimon.utils.SnapshotNotExistException;
import org.apache.paimon.utils.StringUtils;
import org.apache.paimon.view.View;
import org.apache.paimon.view.ViewChange;

import org.apache.paimon.shade.guava30.com.google.common.collect.ImmutableList;
import org.apache.paimon.shade.guava30.com.google.common.collect.ImmutableMap;
import org.apache.paimon.shade.guava30.com.google.common.collect.Lists;
import org.apache.paimon.shade.guava30.com.google.common.collect.Maps;
import org.apache.paimon.shade.org.apache.commons.lang3.StringUtils;

import org.apache.commons.io.FileUtils;
import org.junit.jupiter.api.Assertions;
Expand Down
3 changes: 1 addition & 2 deletions ...mon-flink-1.18/src/main/java/org/apache/paimon/flink/procedure/CreateBranchProcedure.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@
import org.apache.paimon.catalog.Catalog;
import org.apache.paimon.catalog.Identifier;
import org.apache.paimon.table.Table;

import org.apache.paimon.shade.org.apache.commons.lang3.StringUtils;
import org.apache.paimon.utils.StringUtils;

import org.apache.flink.table.procedure.ProcedureContext;

Expand Down
2 changes: 1 addition & 1 deletion .../paimon-flink-common/src/main/java/org/apache/paimon/flink/action/CreateBranchAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

package org.apache.paimon.flink.action;

import org.apache.paimon.shade.org.apache.commons.lang3.StringUtils;
import org.apache.paimon.utils.StringUtils;

import java.util.Map;

Expand Down
3 changes: 1 addition & 2 deletions ...n-flink-common/src/main/java/org/apache/paimon/flink/procedure/CreateBranchProcedure.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@
import org.apache.paimon.catalog.Catalog;
import org.apache.paimon.catalog.Identifier;
import org.apache.paimon.table.Table;

import org.apache.paimon.shade.org.apache.commons.lang3.StringUtils;
import org.apache.paimon.utils.StringUtils;

import org.apache.flink.table.annotation.ArgumentHint;
import org.apache.flink.table.annotation.DataTypeHint;
Expand Down
3 changes: 1 addition & 2 deletions paimon-flink/paimon-flink-common/src/test/java/org/apache/paimon/flink/BranchSqlITCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@
import org.apache.paimon.table.FileStoreTable;
import org.apache.paimon.utils.BlockingIterator;
import org.apache.paimon.utils.SnapshotManager;

import org.apache.paimon.shade.org.apache.commons.lang3.StringUtils;
import org.apache.paimon.utils.StringUtils;

import org.apache.flink.types.Row;
import org.apache.flink.types.RowKind;
Expand Down
3 changes: 1 addition & 2 deletions ...n-flink/paimon-flink-common/src/test/java/org/apache/paimon/flink/CatalogTableITCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@

import org.apache.paimon.catalog.Catalog;
import org.apache.paimon.utils.BlockingIterator;

import org.apache.paimon.shade.org.apache.commons.lang3.StringUtils;
import org.apache.paimon.utils.StringUtils;

import org.apache.flink.table.catalog.CatalogPartition;
import org.apache.flink.table.catalog.CatalogPartitionSpec;
Expand Down
2 changes: 1 addition & 1 deletion paimon-flink/paimon-flink-common/src/test/java/org/apache/paimon/flink/ShowCreateUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

package org.apache.paimon.flink;

import org.apache.paimon.shade.org.apache.commons.lang3.StringUtils;
import org.apache.paimon.utils.StringUtils;

import org.apache.flink.table.api.TableException;
import org.apache.flink.table.catalog.CatalogBaseTable;
Expand Down
2 changes: 1 addition & 1 deletion paimon-spark/paimon-spark-ut/src/test/java/org/apache/paimon/spark/SparkReadTestBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
import org.apache.paimon.types.DataField;
import org.apache.paimon.types.RowKind;

import org.apache.paimon.shade.org.apache.commons.lang3.StringUtils;
import org.apache.paimon.utils.StringUtils;

import org.apache.spark.sql.Dataset;
import org.apache.spark.sql.Row;
Expand Down
2 changes: 1 addition & 1 deletion ...ark/paimon-spark-ut/src/test/java/org/apache/paimon/spark/SparkSchemaEvolutionITCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

package org.apache.paimon.spark;

import org.apache.paimon.shade.org.apache.commons.lang3.StringUtils;
import org.apache.paimon.utils.StringUtils;

import org.apache.spark.sql.AnalysisException;
import org.apache.spark.sql.Dataset;
Expand Down
14 changes: 7 additions & 7 deletions tools/maven/checkstyle.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,12 +189,6 @@ This file is based on the checkstyle file of Apache Beam.
<property name="message"
value="Use Paimon's Preconditions instead of Guava's Preconditions"/>
</module>
<module name="Regexp">
<property name="format" value="import org\.apache\.commons\.lang3\.StringUtils"/>
<property name="illegalPattern" value="true"/>
<property name="message" value="{0}; Use paimon StringUtils or paimon shaded StringUtils instead."/>
</module>

<!-- Enforce Java-style array declarations -->
<module name="ArrayTypeStyle"/>

Expand Down Expand Up @@ -276,6 +270,13 @@ This file is based on the checkstyle file of Apache Beam.
<!--<property name="format" value="com\.google\.api\.client\.util\.(ByteStreams|Charsets|Collections2|Joiner|Lists|Maps|Objects|Preconditions|Sets|Strings|Throwables)"/>-->
<!--</module>-->

<module name="RegexpSinglelineJava">
<property name="format"
value="^import (static )?(org\.apache\.paimon\.shade\.)?org\.apache\.commons\.lang3\.StringUtils.*;$"/>
<property name="message"
value="Use org.apache.paimon.utils.StringUtils instead of commons StringUtils"/>
</module>

<!--
Require static importing from Preconditions.
-->
Expand Down Expand Up @@ -588,4 +589,3 @@ This file is based on the checkstyle file of Apache Beam.

</module>
</module>

Loading