doc(common): deprecate Metadata(String) constructor #284

Now that we have StringElement, people should make up their minds and use one of the elements provided. For backward compatibility until the next major release we keep the constructor, but mark it deprecated so folks start migrating.

Author: poikilotherm

xoai-common/src/main/java/io/gdcc/xoai/model/oaipmh/results/record/Metadata.java

@@ -40,6 +40,16 @@ public Metadata(final XOAIMetadata value) {
         this.element = value;
     }
 
+    /**
+     * Constructs a new instance wrapping the provided {@link String} value as an {@link
+     * EchoElement}.
+     *
+     * @param value The string representation of the metadata content to be wrapped in an {@link
+     *     EchoElement}. This value is parsed and managed for later XML handling operations.
+     * @deprecated Note that this constructor is deprecated and may be removed in a future release.
+     *     Please use {@link Metadata(EchoElement)} (or others) instead.
+     */
+    @Deprecated(forRemoval = true, since = "5.3.0")
     public Metadata(final String value) {
         this.element = new EchoElement(value);
     }