From 07df706db10d1431b50ebb1f446fc1e23ee83c78 Mon Sep 17 00:00:00 2001
From: Toshio Koide <t-koide@onlab.us>
Date: Thu, 30 Oct 2014 10:54:25 -0700
Subject: [PATCH] Add javadocs for LinkResourceStore interface.

---
 .../onos/net/resource/LinkResourceStore.java  | 34 ++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/core/api/src/main/java/org/onlab/onos/net/resource/LinkResourceStore.java b/core/api/src/main/java/org/onlab/onos/net/resource/LinkResourceStore.java
index 30ea79c93c..59d1e19444 100644
--- a/core/api/src/main/java/org/onlab/onos/net/resource/LinkResourceStore.java
+++ b/core/api/src/main/java/org/onlab/onos/net/resource/LinkResourceStore.java
@@ -20,20 +20,52 @@ import java.util.Set;
 import org.onlab.onos.net.Link;
 import org.onlab.onos.net.intent.IntentId;
 
-
 /**
  * Manages link resources.
  */
 public interface LinkResourceStore {
+    /**
+     * Returns free resources for given link.
+     *
+     * @param link a target link
+     * @return free resources for given link
+     */
     Set<ResourceAllocation> getFreeResources(Link link);
 
+    /**
+     * Allocates resources.
+     *
+     * @param allocations resources to be allocated
+     */
     void allocateResources(LinkResourceAllocations allocations);
 
+    /**
+     * Releases resources.
+     *
+     * @param allocations resources to be released
+     */
     void releaseResources(LinkResourceAllocations allocations);
 
+    /**
+     * Returns resources allocated for an Intent.
+     *
+     * @param intentId the target Intent's ID
+     * @return allocated resources
+     */
     LinkResourceAllocations getAllocations(IntentId intentId);
 
+    /**
+     * Returns resources allocated for a link.
+     *
+     * @param link the target link
+     * @return allocated resources
+     */
     Iterable<LinkResourceAllocations> getAllocations(Link link);
 
+    /**
+     * Returns all allocated resources.
+     *
+     * @return allocated resources
+     */
     Iterable<LinkResourceAllocations> getAllocations();
 }