BUG-648: Document AttributesBuilder expectation

This patch just clarifies the expectation that the attributes map does
not change once it is passed in.

Change-Id: Ifd22f5cad85d97cd6bc8f408ad22ac634ed6df16
Signed-off-by: Robert Varga <rovarga@cisco.com>

diff --git a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/builder/api/AttributesBuilder.java b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/builder/api/AttributesBuilder.java
index a7cbfb0e76e753a70cd954c305374e88ef4190da..32172d220efa743726f6314fefe2b462d4b651cc 100644 (file)
--- a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/builder/api/AttributesBuilder.java
+++ b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/builder/api/AttributesBuilder.java
@@ -12,5 +12,12 @@ import java.util.Map;
 import org.opendaylight.yangtools.yang.common.QName;
 
 public interface AttributesBuilder<B> {
+    /**
+     * Attach a map of attributes. The map is expected to remain unchanged,
+     * otherwise undefined behavior may occur.
+     *
+     * @param attributes Attribute map
+     * @return Builder instance, such that fluent use is possible
+     */
     B withAttributes(Map<QName, String> attributes);
 }