Adds toString method to Attributes. Refreshes dependencies. (#4)

Signed-off-by: Laird Nelson <[email protected]>

Author: ljnelson

README.md

@@ -15,7 +15,7 @@ changes, regardless of project version and without notice.**
 
 # Requirements
 
-microBean™ Attributes requires a Java runtime of version 23 or higher.
+microBean™ Attributes requires a Java runtime of version 17 or higher.
 
 # Installation
 
@@ -27,7 +27,7 @@ dependency:
   <groupId>org.microbean</groupId>
   <artifactId>microbean-attributes</artifactId>
   <!-- Always check https://search.maven.org/artifact/org.microbean/microbean-attributes for up-to-date available versions. -->
-  <version>0.0.2</version>
+  <version>0.0.3</version>
 </dependency>
 ```
 

pom.xml

@@ -73,7 +73,7 @@
     <java.util.logging.config.file>${project.basedir}/src/test/java/logging.properties</java.util.logging.config.file>
 
     <!-- maven-compiler-plugin properties -->
-    <maven.compiler.release>23</maven.compiler.release>
+    <maven.compiler.release>17</maven.compiler.release>
     <maven.compiler.showDeprecation>true</maven.compiler.showDeprecation>
     <maven.compiler.showWarnings>true</maven.compiler.showWarnings>
 
@@ -125,7 +125,7 @@
       <dependency>
         <groupId>org.junit</groupId>
         <artifactId>junit-bom</artifactId>
-        <version>5.11.4</version>
+        <version>5.13.1</version>
         <type>pom</type>
         <scope>import</scope>
       </dependency>
@@ -292,7 +292,7 @@
         </plugin>
         <plugin>
           <artifactId>maven-clean-plugin</artifactId>
-          <version>3.4.0</version>
+          <version>3.5.0</version>
           <configuration>
             <filesets>
               <fileset>
@@ -307,7 +307,7 @@
         </plugin>
         <plugin>
           <artifactId>maven-compiler-plugin</artifactId>
-          <version>3.13.0</version>
+          <version>3.14.0</version>
           <configuration>
             <compilerArgs>
               <arg>-Xlint:all</arg>
@@ -328,7 +328,7 @@
         </plugin>
         <plugin>
           <artifactId>maven-deploy-plugin</artifactId>
-          <version>3.1.3</version>
+          <version>3.1.4</version>
         </plugin>
         <plugin>
           <artifactId>maven-enforcer-plugin</artifactId>
@@ -341,7 +341,7 @@
         </plugin>
         <plugin>
           <artifactId>maven-install-plugin</artifactId>
-          <version>3.1.3</version>
+          <version>3.1.4</version>
         </plugin>
         <plugin>
           <artifactId>maven-jar-plugin</artifactId>
@@ -377,7 +377,7 @@
         </plugin>
         <plugin>
           <artifactId>maven-project-info-reports-plugin</artifactId>
-          <version>3.8.0</version>
+          <version>3.9.0</version>
         </plugin>
         <plugin>
           <artifactId>maven-release-plugin</artifactId>
@@ -414,14 +414,7 @@
         </plugin>
         <plugin>
           <artifactId>maven-surefire-plugin</artifactId>
-          <version>3.5.2</version>
-          <dependencies>
-            <dependency>
-              <groupId>org.apache.maven.surefire</groupId>
-              <artifactId>surefire-junit-platform</artifactId>
-              <version>3.5.2</version>
-            </dependency>
-          </dependencies>
+          <version>3.5.3</version>
         </plugin>
         <plugin>
           <artifactId>maven-toolchains-plugin</artifactId>
@@ -430,7 +423,7 @@
         <plugin>
           <groupId>com.github.spotbugs</groupId>
           <artifactId>spotbugs-maven-plugin</artifactId>
-          <version>4.8.6.6</version>
+          <version>4.9.3.0</version>
         </plugin>
         <plugin>
           <groupId>org.codehaus.mojo</groupId>
@@ -440,7 +433,7 @@
         <plugin>
           <groupId>io.smallrye</groupId>
           <artifactId>jandex-maven-plugin</artifactId>
-          <version>3.2.3</version>
+          <version>3.3.1</version>
         </plugin>
         <plugin>
           <groupId>org.sonatype.plugins</groupId>

src/main/java/org/microbean/attributes/Attributes.java

@@ -23,6 +23,7 @@
 import java.util.function.Predicate;
 
 import java.util.Arrays;
+import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
@@ -42,14 +43,20 @@
  * An {@linkplain Attributed attributed} {@link Value} with a {@linkplain #name() name}, {@linkplain #values() named
  * values}, and {@linkplain #notes() non-normative named values}.
  *
- * @param name a non-{@code null} name of this {@link Attributes}
+ * @param name a non-{@code null} name of this {@link Attributes}; names that begin with the {@code $} character are
+ * reserved for internal use
  *
- * @param values a non-{@code null} {@link Map} of named {@linkplain Value values} associated with this {@link Attributes}
+ * @param values a non-{@code null} {@link Map} of named {@linkplain Value values} associated with this {@link
+ * Attributes}; keys in this {@link Map} that begin with the {@code $} character are reserved for internal use
  *
  * @param notes a non-{@code null} {@link Map} of non-normative named {@linkplain Value values} associated with this
- * {@link Attributes}
+ * {@link Attributes}; keys in this {@link Map} that begin with the {@code $} character are reserved for internal use
  *
- * @param attributesMap a non-{@code null} {@link Map} of named metadata associated with this {@link Attributes}
+ * @param attributesMap a non-{@code null} {@link Map} of named metadata associated with this {@link Attributes}; any
+ * {@link List} stored under a key that is equal to the supplied {@code name} is considered to be a list of {@link
+ * Attributes} pertaining to this {@link Attributes} itself; other keys are normally (but are not required to be) the
+ * names of keys in the supplied {@code values} or {@code notes} {@link Map}s; keys that begin with the {@code $}
+ * character are reserved for internal use
  *
  * @author <a href="https://about.me/lairdnelson" target="_top">Laird Nelson</a>
  */
@@ -64,12 +71,17 @@ public final record Attributes(String name,
    *
    * @param name a non-{@code null} name of this {@link Attributes}
    *
-   * @param values a non-{@code null} {@link Map} of named {@linkplain Value values} associated with this {@link Attributes}
+   * @param values a non-{@code null} {@link Map} of named {@linkplain Value values} associated with this {@link
+   * Attributes}; keys in this {@link Map} that begin with the {@code $} character are reserved for internal use
    *
    * @param notes a non-{@code null} {@link Map} of non-normative named {@linkplain Value values} associated with this
-   * {@link Attributes}
+   * {@link Attributes}; keys in this {@link Map} that begin with the {@code $} character are reserved for internal use
    *
-   * @param attributesMap a non-{@code null} {@link Map} of named metadata associated with this {@link Attributes}
+   * @param attributesMap a non-{@code null} {@link Map} of named metadata associated with this {@link Attributes}; any
+   * {@link List} stored under a key that is equal to the supplied {@code name} is considered to be a list of {@link
+   * Attributes} pertaining to this {@link Attributes} itself; other keys are normally (but are not required to be) the
+   * names of keys in the supplied {@code values} or {@code notes} {@link Map}s; keys in this {@link Map} that begin
+   * with the {@code $} character are reserved for internal use
    *
    * @exception NullPointerException if any argument is {@code null}
    */
@@ -234,6 +246,42 @@ public final int hashCode() {
     return hashCode;
   }
 
+  @Override // Record
+  public final String toString() {
+    final StringBuilder sb = new StringBuilder();
+    sb.append("@").append(this.name());
+    final Map<String, Value<?>> values = this.values();
+    final Map<String, Value<?>> notes = this.notes();
+    if (values.isEmpty() && notes.isEmpty()) {
+      return sb.toString();
+    }
+    sb.append("(");
+    if (!values.isEmpty()) {
+      final Iterator<Entry<String, Value<?>>> i = values.entrySet().iterator();
+      while (i.hasNext()) {
+        final Entry<String, Value<?>> e = i.next();
+        sb.append(e.getKey()).append(" = ").append(e.getValue());
+        if (i.hasNext()) {
+          sb.append(", ");
+        }
+      }
+    }
+    if (!notes.isEmpty()) {
+      sb.append(" (");
+      final Iterator<Entry<String, Value<?>>> i = notes.entrySet().iterator();
+      while (i.hasNext()) {
+        final Entry<String, Value<?>> e = i.next();
+        sb.append(e.getKey()).append(" = ").append(e.getValue());
+        if (i.hasNext()) {
+          sb.append(", ");
+        }
+      }
+      sb.append(")");
+    }
+    sb.append(")");
+    return sb.toString();
+  }
+
   /**
    * Returns a suitably-typed {@link Value} indexed under the supplied {@code name}, or {@code null} if no such {@link
    * Value} exists.