Merge pull request #99 from filip26/feat/410

4.1.0

Author: filip26

README.md

@@ -3,6 +3,7 @@
 A Java implementation of [Multibase](https://w3c-ccg.github.io/multibase/).
 
 [![Java 8 CI](https://github.com/filip26/copper-multibase/actions/workflows/java8-build.yml/badge.svg)](https://github.com/filip26/copper-multibase/actions/workflows/java8-build.yml)
+[![javadoc](https://javadoc.io/badge2/com.apicatalog/copper-multibase/javadoc.svg)](https://javadoc.io/doc/com.apicatalog/copper-multibase)
 [![Maven Central](https://img.shields.io/maven-central/v/com.apicatalog/copper-multibase.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:com.apicatalog%20AND%20a:copper-multibase)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
@@ -74,16 +75,10 @@ var decoder = MultibaseDecorer.getInstance(mybase, ...);
 <dependency>
     <groupId>com.apicatalog</groupId>
     <artifactId>copper-multibase</artifactId>
-    <version>4.0.0</version>
+    <version>4.1.0</version>
 </dependency>
 ```
 
-## Documentation
-
-[![javadoc](https://javadoc.io/badge2/com.apicatalog/copper-multibase/javadoc.svg)](https://javadoc.io/doc/com.apicatalog/copper-multibase)
-
-
-
 ## Contributing
 
 All PR's welcome!

SECURITY.md

@@ -0,0 +1,18 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported |
+| ------- |:---------:|
+| 4.x.x   | ✅ Supported |
+| 1.x.x   | ❌ Not supported |
+| 0.x.x   | ❌ Not supported |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability, please report it responsibly by contacting:  
+
+**Filip Kolarik**  
+📧 [filip26@gmail.com](mailto:filip26@gmail.com)
+
+We will investigate promptly and work with you to address the issue. Thank you for helping keep the project secure!

pom.xml

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

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

@@ -85,6 +85,26 @@ public Optional<Multibase> getBase(final String encoded) {
         return getBase(encoded.charAt(0));
     }
 
+    /**
+     * Finds a registered {@link Multibase} encoding by its name.
+     *
+     * <p>
+     * This method searches through all multibases registered with this decoder and
+     * returns the first whose {@link Multibase#name()} matches the given name
+     * exactly.
+     * </p>
+     *
+     * @param name the name of the multibase encoding (must not be {@code null})
+     * @return an {@code Optional} containing the matching {@link Multibase}, or an
+     *         empty {@code Optional} if no encoding with the given name is found
+     * @throws NullPointerException if {@code name} is {@code null}
+     */
+    public final Optional<Multibase> findBase(final String name) {
+        return bases.values().stream()
+                .filter(base -> base.name().equals(name))
+                .findFirst();
+    }
+
     /**
      * Decodes a multibase-encoded string into a byte array.
      *
@@ -98,4 +118,32 @@ public byte[] decode(final String encoded) {
                 .map(base -> base.decode(encoded))
                 .orElseThrow(() -> new IllegalArgumentException("Unsupported multibase encoding [" + encoded.charAt(0) + "]."));
     }
+
+    /**
+     * Returns an unmodifiable view of the registered multibase encodings.
+     *
+     * <p>
+     * The returned map associates each multibase prefix character with its
+     * corresponding {@link Multibase} instance. Attempts to modify the map (e.g.
+     * {@code put}, {@code remove}) will result in an
+     * {@link UnsupportedOperationException}.
+     * </p>
+     *
+     * @return an unmodifiable map of prefix characters to {@link Multibase}
+     *         instances
+     */
+    public Map<Character, Multibase> bases() {
+        return bases;
+    }
+
+    /**
+     * Returns the number of multibase encodings currently registered with this
+     * decoder.
+     *
+     * @return the count of registered encodings
+     */
+    public long size() {
+        return bases.size();
+    }
+
 }

src/main/java/com/apicatalog/multibase/package-info.java

@@ -0,0 +1,29 @@
+/**
+ * Support for <a href="https://multiformats.io/multibase/">multibase</a>.
+ *
+ * <p>
+ * Multibase is a <em>self-describing format</em> for encoding binary data as
+ * text. A multibase-encoded string is prefixed with a single character that
+ * uniquely identifies the base encoding (e.g., {@code 'z'} for Base58-BTC,
+ * {@code 'm'} for Base64). This allows encoded data to carry along the
+ * information needed for correct decoding.
+ * </p>
+ *
+ * <p>
+ * This package provides:
+ * </p>
+ * <ul>
+ * <li>{@link com.apicatalog.multibase.Multibase} – definition of an encoding
+ * format including its name, prefix, alphabet length, and encode/decode
+ * functions.</li>
+ * <li>{@link com.apicatalog.multibase.MultibaseDecoder} – utility for resolving
+ * a registered encoding from its prefix or name and decoding multibase-encoded
+ * strings.</li>
+ * </ul>
+ *
+ * <p>
+ * A set of built-in multibase encodings is available via
+ * {@link com.apicatalog.multibase.Multibase#provided()}.
+ * </p>
+ */
+package com.apicatalog.multibase;