Add appendNullSafe and append string with encoding

Author: patrickfav

CHANGELOG

@@ -4,6 +4,7 @@
  * better resource handling for compression
  * add nullSafe from() constructor
  * rename `toObjectArray()` to `toBoxedArray()` (will be removed in 1.0)
+ * add appendNullSafe and append string with encoding
 
 ## v0.4.6
 

checkstyle.xml

@@ -32,7 +32,7 @@
     </module>
 
     <module name="FileLength"><!-- max line length for single file: http://checkstyle.sourceforge.net/config_sizes.html#FileLength -->
-        <property name="max" value="1500"/>
+        <property name="max" value="3500"/>
     </module>
 
     <module name="TreeWalker">

src/main/java/at/favre/lib/bytes/Bytes.java

@@ -652,15 +652,39 @@ public Bytes append(byte[] secondArray) {
         return transform(new BytesTransformer.ConcatTransformer(secondArray));
     }
 
+    /**
+     * Creates a new instance with the current array appended to the provided data (ie. append at the end)
+     * <p>
+     * If given array is null, the nothing will be appended.
+     *
+     * @param secondArrayNullable to append, may be null
+     * @return appended instance or same if passed array is null
+     */
+    public Bytes appendNullSafe(byte[] secondArrayNullable) {
+        return secondArrayNullable == null ? this : append(secondArrayNullable);
+    }
+
     /**
      * Creates a new instance with the current array appended to the provided utf-8 encoded representation of this string
      *
-     * @param string string used to get utf-8 bytes from
+     * @param stringUtf8 string used to get utf-8 bytes from
+     * @return appended instance
+     */
+    public Bytes append(CharSequence stringUtf8) {
+        return append(stringUtf8, StandardCharsets.UTF_8);
+    }
+
+    /**
+     * Creates a new instance with the current array appended to the provided string with provided encoding
+     *
+     * @param string  string used to get bytes from
+     * @param charset encoding of provided string
      * @return appended instance
      */
-    public Bytes append(CharSequence string) {
+    public Bytes append(CharSequence string, Charset charset) {
+        Objects.requireNonNull(charset);
         Objects.requireNonNull(string);
-        return transform(new BytesTransformer.ConcatTransformer(string.toString().getBytes(StandardCharsets.UTF_8)));
+        return transform(new BytesTransformer.ConcatTransformer(string.toString().getBytes(charset)));
     }
 
     /**
@@ -1393,6 +1417,7 @@ public List<Byte> toList() {
 
     /**
      * @deprecated renamed API, use {@link #toBoxedArray()} instead - will be removed in v1.0+
+     * @return see {@link #toBoxedArray()}
      */
     @Deprecated
     public Byte[] toObjectArray() {

src/test/java/at/favre/lib/bytes/ABytesTest.java

@@ -53,6 +53,7 @@ public abstract class ABytesTest {
 
     byte[] example_bytes_twentyfour;
     String example_hex_twentyfour;
+
     @Before
     public void setUp() throws Exception {
         example_bytes_empty = new byte[0];

src/test/java/at/favre/lib/bytes/Base64Test.java

@@ -31,7 +31,7 @@
 public class Base64Test {
 
     @Test
-    public void decode() throws Exception {
+    public void decode() {
         assertArrayEquals("".getBytes(), Base64.decode(""));
         assertArrayEquals("f".getBytes(), Base64.decode("Zg=="));
         assertArrayEquals("fo".getBytes(), Base64.decode("Zm8="));
@@ -47,7 +47,7 @@ public void decode() throws Exception {
     }
 
     @Test
-    public void encode() throws Exception {
+    public void encode() {
         assertEquals("", Base64.encode("".getBytes()));
         assertEquals("Zg==", Base64.encode("f".getBytes()));
         assertEquals("Zm8=", Base64.encode("fo".getBytes()));
@@ -60,4 +60,4 @@ public void encode() throws Exception {
 
     }
 
-}
+}

src/test/java/at/favre/lib/bytes/BinaryToTextEncodingTest.java

@@ -30,26 +30,26 @@
 
 public class BinaryToTextEncodingTest {
     @Test
-    public void encodeHex() throws Exception {
+    public void encodeHex() {
         assertEquals("010203", new BinaryToTextEncoding.Hex(false).encode(new byte[]{1, 2, 3}, ByteOrder.BIG_ENDIAN));
         assertEquals("030201", new BinaryToTextEncoding.Hex(false).encode(new byte[]{1, 2, 3}, ByteOrder.LITTLE_ENDIAN));
         assertNotEquals(new BinaryToTextEncoding.Hex(false).encode(new byte[]{1, 2, 3}, ByteOrder.LITTLE_ENDIAN), new BinaryToTextEncoding.Hex(false).encode(new byte[]{1, 2, 3}, ByteOrder.BIG_ENDIAN));
     }
 
     @Test(expected = IllegalArgumentException.class)
-    public void decodeHexShouldFail() throws Exception {
+    public void decodeHexShouldFail() {
         new BinaryToTextEncoding.Hex(false).decode("AAI=");
     }
 
     @Test
-    public void encodeBaseRadix() throws Exception {
+    public void encodeBaseRadix() {
         assertEquals("100211", new BinaryToTextEncoding.BaseRadix(16).encode(new byte[]{16, 2, 17}, ByteOrder.BIG_ENDIAN));
         assertEquals("110210", new BinaryToTextEncoding.BaseRadix(16).encode(new byte[]{16, 2, 17}, ByteOrder.LITTLE_ENDIAN));
         assertNotEquals(new BinaryToTextEncoding.BaseRadix(2).encode(new byte[]{1, 2, 3}, ByteOrder.LITTLE_ENDIAN), new BinaryToTextEncoding.BaseRadix(2).encode(new byte[]{1, 2, 3}, ByteOrder.BIG_ENDIAN));
     }
 
     @Test
-    public void encodeDecodeRadix() throws Exception {
+    public void encodeDecodeRadix() {
         for (int i = 0; i < 32; i++) {
             Bytes rnd = Bytes.random(i);
             System.out.println("\n\nNEW TEST: " + i + " bytes\n");
@@ -67,7 +67,7 @@ public void encodeDecodeRadix() throws Exception {
 
     @Test
     @Ignore("should fix")
-    public void encodeDecodeRadixZeros() throws Exception {
+    public void encodeDecodeRadixZeros() {
         Bytes bytes = Bytes.wrap(new byte[]{0, 0, 0, 0});
         BinaryToTextEncoding.EncoderDecoder encoding = new BinaryToTextEncoding.BaseRadix(36);
         String encodedBigEndian = encoding.encode(bytes.array(), ByteOrder.BIG_ENDIAN);
@@ -80,7 +80,7 @@ public void encodeDecodeRadixZeros() throws Exception {
     }
 
     @Test
-    public void encodeDecodeBase64() throws Exception {
+    public void encodeDecodeBase64() {
         for (int i = 4; i < 32; i += 4) {
             Bytes rnd = Bytes.random(i);
             BinaryToTextEncoding.EncoderDecoder encoding = new BinaryToTextEncoding.Base64Encoding();
@@ -91,7 +91,7 @@ public void encodeDecodeBase64() throws Exception {
     }
 
     @Test
-    public void encodeDecodeHex() throws Exception {
+    public void encodeDecodeHex() {
         for (int i = 4; i < 32; i += 4) {
             Bytes rnd = Bytes.random(i);
             BinaryToTextEncoding.EncoderDecoder encoding = new BinaryToTextEncoding.Hex();
@@ -102,30 +102,30 @@ public void encodeDecodeHex() throws Exception {
     }
 
     @Test(expected = IllegalArgumentException.class)
-    public void decodeInvalidRadix16() throws Exception {
+    public void decodeInvalidRadix16() {
         new BinaryToTextEncoding.BaseRadix(16).decode("AAI=");
     }
 
     @Test(expected = IllegalArgumentException.class)
-    public void decodeInvalidRadix36() throws Exception {
+    public void decodeInvalidRadix36() {
         new BinaryToTextEncoding.BaseRadix(36).decode("AAI=");
     }
 
     @Test
-    public void encodeBase64() throws Exception {
+    public void encodeBase64() {
         assertEquals("EAIR", new BinaryToTextEncoding.Base64Encoding().encode(new byte[]{16, 2, 17}, ByteOrder.BIG_ENDIAN));
         assertEquals("EQIQ", new BinaryToTextEncoding.Base64Encoding().encode(new byte[]{17, 2, 16}, ByteOrder.BIG_ENDIAN));
         assertEquals("EQIQ", new BinaryToTextEncoding.Base64Encoding().encode(new byte[]{16, 2, 17}, ByteOrder.LITTLE_ENDIAN));
         assertNotEquals(new BinaryToTextEncoding.Base64Encoding().encode(new byte[]{1, 2, 3}, ByteOrder.LITTLE_ENDIAN), new BinaryToTextEncoding.Base64Encoding().encode(new byte[]{1, 2, 3}, ByteOrder.BIG_ENDIAN));
     }
 
     @Test(expected = IllegalArgumentException.class)
-    public void decodeInvalidBase64() throws Exception {
+    public void decodeInvalidBase64() {
         new BinaryToTextEncoding.Base64Encoding().decode("(&´´");
     }
 
     @Test(expected = IllegalArgumentException.class)
-    public void decodeHalfInvalidBase64() throws Exception {
+    public void decodeHalfInvalidBase64() {
         new BinaryToTextEncoding.Base64Encoding().decode("EAI`");
     }
-}
+}