Merge pull request #27 from filip26/patch/v0.0.2

Patch/v0.0.2

pom.xml

@@ -7,7 +7,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.apicatalog</groupId>
     <artifactId>copper-multibase</artifactId>
-    <version>0.0.1</version>
+    <version>0.0.2</version>
     <packaging>jar</packaging>
 
     <name>Copper Multibase</name>

src/main/java/com/apicatalog/multibase/Multibase.java

@@ -47,6 +47,19 @@ public int length() {
         return length;
     }
 
+    /**
+     * Checks if the given value is encoded with the base.
+     * 
+     * @param encoded an encoded value to test
+     * @return <code>true</code> is the given value is encoded with the base,
+     *         <code>false</code> otherwise
+     */
+    public boolean isEncoded(final String encoded) {
+        return encoded != null
+                && encoded.trim().length() > 0
+                && prefix == encoded.charAt(0);
+    }
+
     /**
      * Decodes the given data into byte array.
      * 

src/main/java/com/apicatalog/multibase/MultibaseDecoder.java

@@ -14,12 +14,33 @@ protected MultibaseDecoder(Map<Character, Multibase> bases) {
         this.bases = bases;
     }
 
+    /**
+     * A new instance initialized with all supported bases.
+     * 
+     * @return a new instance
+     */
+    public static MultibaseDecoder getInstance() {
+        return getInstance(Multibase.BASE_58_BTC);
+    }
+
+    /**
+     * A new instance initialized with the given bases.
+     * 
+     * @param bases to initialize the decoder
+     * @return a new instance
+     */
     public static MultibaseDecoder getInstance(Multibase... bases) {
         return new MultibaseDecoder(
                 Arrays.stream(bases)
                         .collect(Collectors.toMap(Multibase::prefix, Function.identity())));
     }
 
+    /**
+     * Tries to detect the base used for encoding.
+     * 
+     * @param encoded an encoded value
+     * @return detected base encoding or {@link Optional#empty()}
+     */
     public Optional<Multibase> getBase(final String encoded) {
 
         if (encoded == null) {

src/test/java/com/apicatalog/multibase/MultibaseTest.java

@@ -2,9 +2,12 @@
 
 import static org.junit.jupiter.api.Assertions.assertArrayEquals;
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import java.util.stream.Stream;
 
+import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.Arguments;
 import org.junit.jupiter.params.provider.MethodSource;
@@ -19,19 +22,29 @@ void testBase58BTCEncode(String expected, byte[] data) {
         String output = Multibase.BASE_58_BTC.encode(data);
         assertEquals(expected, output);
     }
-    
+
     @ParameterizedTest(name = "{index}: {0}")
     @MethodSource("testData")
     void testDecode(String encoded, byte[] expected) {
         byte[] output = DECODER.decode(encoded);
         assertArrayEquals(expected, output);
     }
 
+    @ParameterizedTest(name = "{index}: {0}")
+    @MethodSource("testData")
+    void testIsBase58BTCEncoded(String encoded, byte[] data) {
+        assertTrue(Multibase.BASE_58_BTC.isEncoded(encoded));
+    }
+
+    @Test
+    void testIsNotBase58BTCEncoded() {
+        assertFalse(Multibase.BASE_58_BTC.isEncoded("abc"));
+    }
+
     static Stream<Arguments> testData() {
         return Stream.of(
-          Arguments.of("zUXE7GvtEk8XTXs1GF8HSGbVA9FCX9SEBPe", "Decentralize everything!!".getBytes()),
-          Arguments.of("zStV1DL6CwTryKyV", "hello world".getBytes()),
-          Arguments.of("z7paNL19xttacUY", "yes mani !".getBytes())
-        );
+                Arguments.of("zUXE7GvtEk8XTXs1GF8HSGbVA9FCX9SEBPe", "Decentralize everything!!".getBytes()),
+                Arguments.of("zStV1DL6CwTryKyV", "hello world".getBytes()),
+                Arguments.of("z7paNL19xttacUY", "yes mani !".getBytes()));
     }
 }