Improve documentation
authorMathieu Baudier <mbaudier@argeo.org>
Tue, 13 Jun 2023 06:10:54 +0000 (08:10 +0200)
committerMathieu Baudier <mbaudier@argeo.org>
Tue, 13 Jun 2023 06:10:54 +0000 (08:10 +0200)
org.argeo.api.acr/src/org/argeo/api/acr/Content.java

index f52ab31b8f25223e109b4781707502f924cd5ebd..d48f583fd7c84e4fc33c5f97f8493664c609f3b6 100644 (file)
@@ -242,6 +242,14 @@ public interface Content extends Iterable<Content>, Map<QName, Object> {
        /*
         * ATTR AS STRING
         */
+       /**
+        * Convenience method returning an attribute as a {@link String}.
+        * 
+        * @param key the attribute name
+        * @return the attribute value as a {@link String} or <code>null</code>.
+        * 
+        * @see Object#toString()
+        */
        default String attr(QName key) {
                // TODO check String type?
                Object obj = get(key);
@@ -250,21 +258,29 @@ public interface Content extends Iterable<Content>, Map<QName, Object> {
                return obj.toString();
        }
 
+       /**
+        * Convenience method returning an attribute as a {@link String}.
+        * 
+        * @param key the attribute name
+        * @return the attribute value as a {@link String} or <code>null</code>.
+        * 
+        * @see Object#toString()
+        */
        default String attr(QNamed key) {
                return attr(key.qName());
        }
 
+       /**
+        * Convenience method returning an attribute as a {@link String}.
+        * 
+        * @param key the attribute name
+        * @return the attribute value as a {@link String} or <code>null</code>.
+        * 
+        * @see Object#toString()
+        */
        default String attr(String key) {
                return attr(unqualified(key));
        }
-//
-//     default String attr(Object key) {
-//             return key != null ? attr(key.toString()) : attr(null);
-//     }
-//
-//     default <A> A get(Object key, Class<A> clss) {
-//             return key != null ? get(key.toString(), clss) : get(null, clss);
-//     }
 
        /*
         * EXPERIMENTAL UNSUPPORTED