[IoTivity Simulator] Handling resource interfaces.

[platform/upstream/iotivity.git] / service / simulator / java / sdk / src / org / oic / simulator / SimulatorResourceModel.java

diff --git a/service/simulator/java/sdk/src/org/oic/simulator/SimulatorResourceModel.java b/service/simulator/java/sdk/src/org/oic/simulator/SimulatorResourceModel.java
index c1e3b80..65623c7 100644 (file)
--- a/service/simulator/java/sdk/src/org/oic/simulator/SimulatorResourceModel.java
+++ b/service/simulator/java/sdk/src/org/oic/simulator/SimulatorResourceModel.java
@@ -20,7 +20,9 @@ import java.util.HashMap;
 import java.util.Map;
 
 /**
- * This class represents the resource model of a resource.
+ * This class represents the resource model of a resource. A resource model
+ * contains a set of attributes and their properties. It represents the complex
+ * value type of an attribute.
  */
 public class SimulatorResourceModel {
 
@@ -28,7 +30,7 @@ public class SimulatorResourceModel {
     private Map<String, AttributeProperty> mProperties = null;
 
     /**
-     * Constructs new {@SimulatorResourceModel} object.
+     * Constructs new {@link SimulatorResourceModel} object.
      */
     public SimulatorResourceModel() {
         mValues = new HashMap<>();
@@ -61,7 +63,7 @@ public class SimulatorResourceModel {
      * API to add an attribute to resource model.
      *
      * @param attribute
-     *            {@link SimulatorResourceAttribute} to be add to resource
+     *            {@link SimulatorResourceAttribute} to be added to resource
      *            model.
      *
      * @throws InvalidArgsException
@@ -127,9 +129,6 @@ public class SimulatorResourceModel {
      *         corresponding {@link SimulatorResourceAttribute} as value.
      */
     public Map<String, SimulatorResourceAttribute> getAttributes() {
-        if (mValues.size() == 0)
-            return null;
-
         Map<String, SimulatorResourceAttribute> attributes = new HashMap<>();
         for (Map.Entry<String, AttributeValue> entry : mValues.entrySet()) {
             SimulatorResourceAttribute attribute = new SimulatorResourceAttribute(
@@ -160,7 +159,7 @@ public class SimulatorResourceModel {
     }
 
     /**
-     * API to check whether resource model has attribute.
+     * API to check whether resource model has an attribute with given name.
      *
      * @param attrName
      *            Name of the attribute.
@@ -180,7 +179,9 @@ public class SimulatorResourceModel {
      * @param attrName
      *            Name of the attribute.
      *
-     * @return Attribute value type information {@AttributeValue.TypeInfo}.
+     * @return Attribute value type information {@link AttributeValue.TypeInfo
+     * 
+     * }.
      */
     public AttributeValue.TypeInfo getAttributeType(String attrName) {
         if (mValues.containsKey(attrName))
@@ -194,8 +195,8 @@ public class SimulatorResourceModel {
      * @param attrName
      *            Name of the attribute.
      *
-     * @return true if resource model has attribute it is removed, otherwise
-     *         false.
+     * @return true if resource model has an attribute with the given name,
+     *         otherwise false.
      */
     public boolean removeAttribute(String attrName) {
         if (mValues.containsKey(attrName)) {
@@ -220,6 +221,10 @@ public class SimulatorResourceModel {
     /**
      * API to update the attribute values from given
      * {@link SimulatorResourceModel}.
+     * 
+     * @param resourceModel
+     *            {@link SimulatorResourceModel} holding the new attribute
+     *            values.
      */
     public void update(SimulatorResourceModel resourceModel) {
         if (null == resourceModel || 0 == resourceModel.size())
@@ -243,7 +248,6 @@ public class SimulatorResourceModel {
         }
     }
 
-    // Methods used in native code
     private SimulatorResourceModel(Map<String, AttributeValue> values,
             Map<String, AttributeProperty> properties) {
         mValues = values;