add docs 📖

Author: publicarray

SCache.java

@@ -8,19 +8,31 @@ public class SCache {
     private Map<String, HttpResponse> cacheStore;
     HttpRequest request;
 
+    /**
+     * [SCache description]
+     */
     public SCache() {
         // synchronised HasMap prevents data corruption when reading while writing the Map
         cacheStore = Collections.synchronizedMap(new HashMap<String, HttpResponse>());
         request = new HttpRequest("GET", "", "HTTP/1.1", "", "", 0);
     }
 
-    // add value to HashMap
+    /**
+     * Add the HttpResponse into the HashMap cache with the url as the key.
+     * @param  key   The Url
+     * @param  value The HttpResponse
+     * @return       The given value HttpResponse
+     */
     public HttpResponse put(String key, HttpResponse value) {
         System.out.println("SCACHE: Saved " + key + " to cache.");
         return cacheStore.put(key, value);
     }
 
-    // retrieve value from HashMap
+    /**
+     * Retrieves the HttpResponse from HashMap cache by looking up the url
+     * @param  key The Url
+     * @return     The Cached HttpResponse
+     */
     public HttpResponse get(String key) {
         System.out.println("SCACHE: looking for " + key + " in cache.");
         HttpResponse value = cacheStore.get(key);
@@ -39,6 +51,12 @@ public HttpResponse get(String key) {
     }
 
     // check if response is still valid
+    /**
+     * Determine if the Cache HttpResonse is still fresh.
+     * @param  requestURL The key in the cache
+     * @param  response   The value in the cache
+     * @return            isValid? as in is the item in the cache fresh?
+     */
     public boolean isValid(String requestURL, HttpResponse response) {
         if (!response.isExpired()) { // TODO: add command line flag
             System.out.println("SCACHE: response has not expired");
@@ -67,6 +85,11 @@ public boolean isValid(String requestURL, HttpResponse response) {
         // return false;
     }
 
+    /**
+     * From a url string get the hostname
+     * @param  url The Url (http://example.com/foo)
+     * @return     The Hostname (example.com)
+     */
     public static String getHost(String url) {
         if (url == null || url.length() <= 0) {
             return "";
@@ -86,6 +109,11 @@ public static String getHost(String url) {
         return url.substring(start, end);
     }
 
+    /**
+     * From a utl string get the port number
+     * @param  url The Url (http://example.com:50/foo)
+     * @return     The Port number (50)
+     */
     public static int getPort(String url) {
         if (url == null || url.length() <= 0) {
             return 80;
@@ -115,6 +143,11 @@ public static int getPort(String url) {
         return Integer.parseInt(url.substring(port, end));
     }
 
+    /**
+     * From a url string get the location
+     * @param  url The Url (http://example.com/foo)
+     * @return     The location (/foo)
+     */
     public static String getLocation(String url) {
         if (url == null || url.length() <= 0) {
             return "";