Apache
/
commons-lang
mirror of https://github.com/apache/commons-lang.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[LANG-1461] Add null-safe StringUtils APIs to wrap 

String#getBytes([Charset|String]).</action>
This commit is contained in:
Gary Gregory 2019-06-03 12:00:13 -04:00
parent 1dd511132f
commit e5e1339e44
5 changed files with 172 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/changes/changes.xml
View File

@ -50,6 +50,7 @@ The <action> type attribute can be add,update,fix,remove.
<action issue="LANG-1457" type="add" dev="ggregory">Add ExceptionUtils.throwableOfType(Throwable, Class) and friends.</action>
<action issue="LANG-1458" type="add" dev="ggregory">Add EMPTY_ARRAY constants to classes in org.apache.commons.lang3.tuple.</action>
<action type="update" dev="ggregory">checkstyle.version 8.18 -> 8.20.</action>
<action issue="LANG-1461" type="add" dev="ggregory">Add null-safe StringUtils APIs to wrap String#getBytes([Charset|String]).</action>
</release>
<release version="3.9" date="2019-04-09" description="New features and bug fixes. Requires Java 8, supports Java 9, 10, 11">

69
src/main/java/org/apache/commons/lang3/Charsets.java Normal file
View File

@ -0,0 +1,69 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.lang3;
import java.nio.charset.Charset;
import java.nio.charset.UnsupportedCharsetException;
/**
* Internal use only.
* <p>
* Provides utilities for {@link Charset}.
* </p>
* <p>
* Package private since Apache Commons IO already provides a Charsets because {@link Charset} is in
* {@code java.nio.charset}.
* </p>
*
* @since 3.10
*/
class Charsets {
/**
* Returns the given {@code charset} or the default Charset if {@code charset} is null.
*
* @param charset a Charset or null.
* @return the given {@code charset} or the default Charset if {@code charset} is null.
*/
static Charset toCharset(final Charset charset) {
return charset == null ? Charset.defaultCharset() : charset;
}
/**
* Returns the given {@code charset} or the default Charset if {@code charset} is null.
*
* @param charsetName a Charset or null.
* @return the given {@code charset} or the default Charset if {@code charset} is null.
* @throws UnsupportedCharsetException If no support for the named charset is available in this instance of the Java
* virtual machine
*/
static Charset toCharset(final String charsetName) {
return charsetName == null ? Charset.defaultCharset() : Charset.forName(charsetName);
}
/**
* Returns the given {@code charset} or the default Charset if {@code charset} is null.
*
* @param charsetName a Charset or null.
* @return the given {@code charset} or the default Charset if {@code charset} is null.
*/
static String toCharsetName(final String charsetName) {
return charsetName == null ? Charset.defaultCharset().name() : charsetName;
}
}

31
src/main/java/org/apache/commons/lang3/StringUtils.java
View File

@ -1457,7 +1457,6 @@ public static int countMatches(final CharSequence str, final CharSequence sub) {
return count;
}
/**
* <p>Returns either the passed in CharSequence, or if the CharSequence is
* whitespace, empty ("") or {@code null}, the value of {@code defaultStr}.</p>
@ -1482,6 +1481,7 @@ public static <T extends CharSequence> T defaultIfBlank(final T str, final T def
return isBlank(str) ? defaultStr : str;
}
/**
* <p>Returns either the passed in CharSequence, or if the CharSequence is
* empty or {@code null}, the value of {@code defaultStr}.</p>
@ -1948,6 +1948,33 @@ public static <T extends CharSequence> T firstNonEmpty(final T... values) {
return null;
}
/**
* Calls {@link String#getBytes(Charset)} in a null-safe manner.
*
* @param string
* @param charset The {@link Charset} to encode the {@code String}. If null, then use the default Charset.
* @return The empty byte[] if {@code string} is null, the result of {@link String#getBytes(Charset)} otherwise.
* @see String#getBytes(Charset)
* @since 3.10
*/
public static byte[] getBytes(final String string, final Charset charset) {
return string == null ? ArrayUtils.EMPTY_BYTE_ARRAY : string.getBytes(Charsets.toCharset(charset));
}
/**
* Calls {@link String#getBytes(String)} in a null-safe manner.
*
* @param string
* @param charset The {@link Charset} name to encode the {@code String}. If null, then use the default Charset.
* @return The empty byte[] if {@code string} is null, the result of {@link String#getBytes(String)} otherwise.
* @throws UnsupportedEncodingException Thrown when the named charset is not supported.
* @see String#getBytes(String)
* @since 3.10
*/
public static byte[] getBytes(final String string, final String charset) throws UnsupportedEncodingException {
return string == null ? ArrayUtils.EMPTY_BYTE_ARRAY : string.getBytes(Charsets.toCharsetName(charset));
}
/**
* <p>Compares all Strings in an array and returns the initial sequence of
* characters that is common to all of them.</p>
@ -8863,7 +8890,7 @@ public static int[] toCodePoints(final CharSequence str) {
* @since 3.3 No longer throws {@link UnsupportedEncodingException}.
*/
public static String toEncodedString(final byte[] bytes, final Charset charset) {
return new String(bytes, charset != null ? charset : Charset.defaultCharset());
return new String(bytes, Charsets.toCharset(charset));
}
/**

50
src/test/java/org/apache/commons/lang3/CharsetsTestCase.java Normal file
View File

@ -0,0 +1,50 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.lang3;
import java.nio.charset.Charset;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
/**
* Tests {@link Charsets}.
*/
public class CharsetsTestCase {
@Test
public void testToCharset_Charset() {
Assertions.assertEquals(Charset.defaultCharset(), Charsets.toCharset((Charset) null));
Assertions.assertEquals(Charset.defaultCharset(), Charsets.toCharset(Charset.defaultCharset()));
Assertions.assertEquals(Charset.forName("UTF-8"), Charsets.toCharset(Charset.forName("UTF-8")));
}
@Test
public void testToCharset_String() {
Assertions.assertEquals(Charset.defaultCharset(), Charsets.toCharset((String) null));
Assertions.assertEquals(Charset.defaultCharset(), Charsets.toCharset(Charset.defaultCharset().name()));
Assertions.assertEquals(Charset.forName("UTF-8"), Charsets.toCharset("UTF-8"));
}
@Test
public void testToCharsetName() {
Assertions.assertEquals(Charset.defaultCharset().name(), Charsets.toCharsetName((String) null));
Assertions.assertEquals("UTF-8", Charsets.toCharsetName("UTF-8"));
}
}

25
src/test/java/org/apache/commons/lang3/StringUtilsTest.java
View File

@ -31,6 +31,7 @@
import java.lang.reflect.Modifier;
import java.nio.CharBuffer;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.Collections;
import java.util.Iterator;
@ -795,6 +796,22 @@ public void testEscapeSurrogatePairsLang858() {
assertEquals("\\uDBFF\\uDFFD", StringEscapeUtils.escapeEcmaScript("\uDBFF\uDFFD")); //fail LANG-858
}
@Test
public void testGetBytes_Charset() {
assertEquals(ArrayUtils.EMPTY_BYTE_ARRAY, StringUtils.getBytes(null, (Charset) null));
assertArrayEquals(StringUtils.EMPTY.getBytes(), StringUtils.getBytes(StringUtils.EMPTY, (Charset) null));
assertArrayEquals(StringUtils.EMPTY.getBytes(StandardCharsets.US_ASCII),
StringUtils.getBytes(StringUtils.EMPTY, StandardCharsets.US_ASCII));
}
@Test
public void testGetBytes_String() throws UnsupportedEncodingException {
assertEquals(ArrayUtils.EMPTY_BYTE_ARRAY, StringUtils.getBytes(null, (String) null));
assertArrayEquals(StringUtils.EMPTY.getBytes(), StringUtils.getBytes(StringUtils.EMPTY, (String) null));
assertArrayEquals(StringUtils.EMPTY.getBytes(StandardCharsets.US_ASCII.name()),
StringUtils.getBytes(StringUtils.EMPTY, StandardCharsets.US_ASCII.name()));
}
@Test
public void testGetCommonPrefix_StringArray() {
assertEquals("", StringUtils.getCommonPrefix((String[]) null));
@ -2790,7 +2807,9 @@ public void testStringUtilsCharSequenceContract() {
"public static int org.apache.commons.lang3.StringUtils.compare(java.lang.String,java.lang.String)",
"public static int org.apache.commons.lang3.StringUtils.compare(java.lang.String,java.lang.String,boolean)",
"public static int org.apache.commons.lang3.StringUtils.compareIgnoreCase(java.lang.String,java.lang.String)",
"public static int org.apache.commons.lang3.StringUtils.compareIgnoreCase(java.lang.String,java.lang.String,boolean)"
"public static int org.apache.commons.lang3.StringUtils.compareIgnoreCase(java.lang.String,java.lang.String,boolean)",
"public static byte[] org.apache.commons.lang3.StringUtils.getBytes(java.lang.String,java.nio.charset.Charset)",
"public static byte[] org.apache.commons.lang3.StringUtils.getBytes(java.lang.String,java.lang.String) throws java.io.UnsupportedEncodingException"
};
final Method[] methods = c.getMethods();
@ -3019,6 +3038,8 @@ public void testTruncate_StringIntInt() {
assertEquals("", StringUtils.truncate("abcdefghijklmno", Integer.MAX_VALUE, Integer.MAX_VALUE));
}
// -----------------------------------------------------------------------
@Test
public void testUnCapitalize() {
assertNull(StringUtils.uncapitalize(null));
@ -3034,8 +3055,6 @@ public void testUnCapitalize() {
assertEquals("cAT", StringUtils.uncapitalize("CAT"));
}
// -----------------------------------------------------------------------
@Test
public void testUnescapeSurrogatePairs() {
assertEquals("\uD83D\uDE30", StringEscapeUtils.unescapeCsv("\uD83D\uDE30"));