Propagate @Nonnull and @Nullable annotations
[yangtools.git] / yang / yang-data-api / src / main / java / org / opendaylight / yangtools / yang / data / api / AttributesContainer.java
index 5f1b2522ab675800eb07775c699c55402285aa84..7bbfb8828528a18e032c88e056273d4e46ee54d0 100644 (file)
@@ -8,14 +8,29 @@
 package org.opendaylight.yangtools.yang.data.api;
 
 import java.util.Map;
-
 import org.opendaylight.yangtools.yang.common.QName;
 
+/**
+ *
+ * Container of attributes, which may be attached to nodes.
+ *
+ */
 public interface AttributesContainer {
 
-    
-    Map<QName,String> getAttributes();
-    
-    Object getAttributeValue(QName value);
-    
+    /**
+     * Returns immutable map of QName and value of the attribute.
+     *
+     * @return immutable map of attribute names and values.
+     */
+    Map<QName, String> getAttributes();
+
+    /**
+     * Returns attribute value by supplied QName
+     *
+     *
+     * @param name Attribute name
+     * @return Value of attribute if present, null otherwise.
+     */
+    Object getAttributeValue(QName name);
+
 }