Revise Javadoc
- Remove the word "path" as no ResourcePath anymore
- Write conditions that a method throws an exception
Change-Id: Ie2f2e1cfd1c6c68051e6700ef4308363a71d9453
diff --git a/core/api/src/main/java/org/onosproject/net/newresource/Resource.java b/core/api/src/main/java/org/onosproject/net/newresource/Resource.java
index c402b42..199e9c5 100644
--- a/core/api/src/main/java/org/onosproject/net/newresource/Resource.java
+++ b/core/api/src/main/java/org/onosproject/net/newresource/Resource.java
@@ -42,9 +42,9 @@
DiscreteResource ROOT = new DiscreteResource();
/**
- * Returns the components of this resource path.
+ * Returns the components of this resource.
*
- * @return the components of this resource path
+ * @return the components of this resource
*/
List<Object> components();
@@ -58,30 +58,34 @@
<T> T volume();
/**
- * Returns the parent resource path of this instance.
- * E.g. if this path is Link:1/VLAN ID:100, the return value is the resource path for Link:1.
+ * Returns the parent resource of this instance.
+ * E.g. if this resource is Link:1/VLAN ID:100, the return value is the resource for Link:1.
*
- * @return the parent resource path of this instance.
+ * @return the parent resource of this instance.
* If there is no parent, empty instance will be returned.
*/
Optional<DiscreteResource> parent();
/**
- * Returns a child resource path of this instance with specifying the child object.
- * The child resource path is discrete-type.
+ * Returns a child resource of this instance with specifying the child object.
+ * It is not allowed that a continuous type resource has a child. If the instance is
+ * ContinuousResource, {@link UnsupportedOperationException} is thrown. If the given
+ * object is a {@link Class} instance, {@link IllegalArgumentException} is thrown.
*
* @param child child object
- * @return a child resource path
+ * @return a child resource
+ * @throws IllegalArgumentException if the given object is a {@link Class} instance.
*/
DiscreteResource child(Object child);
/**
- * Returns a child resource path of this instance with specifying a child object and
- * value. The child resource path is continuous-type.
+ * Returns a child resource of this instance with specifying a child object and
+ * value. It is not allowed that a continuous type resource has a child. If the instance is
+ * ContinuousResource, {@link UnsupportedOperationException} is thrown.
*
* @param child child object
* @param value value
- * @return a child resource path
+ * @return a child resource
*/
ContinuousResource child(Class<?> child, double value);
@@ -94,9 +98,9 @@
Object last();
/**
- * Returns the ID of this resource path.
+ * Returns the ID of this resource.
*
- * @return the ID of this resource path
+ * @return the ID of this resource
*/
ResourceId id();
}
diff --git a/core/api/src/main/java/org/onosproject/net/newresource/ResourceId.java b/core/api/src/main/java/org/onosproject/net/newresource/ResourceId.java
index ee1660d..262cef2 100644
--- a/core/api/src/main/java/org/onosproject/net/newresource/ResourceId.java
+++ b/core/api/src/main/java/org/onosproject/net/newresource/ResourceId.java
@@ -30,7 +30,7 @@
/**
* Returns the parent resource ID of this instance.
*
- * @return the parent resource path of this instance.
+ * @return the parent resource ID of this instance.
* If there is no parent, empty instance will be returned.
*/
public abstract Optional<DiscreteResourceId> parent();