From f0e585d22c24eec3a723c6f0ea2a18252c570303 Mon Sep 17 00:00:00 2001
From: bculkin2442 <bjculkin@mix.wvu.edu>
Date: Wed, 16 Nov 2016 11:22:33 -0500
Subject: Documentation update

---
 BJC-Utils2/src/main/java/bjc/utils/funcdata/IList.java |  8 ++++++++
 BJC-Utils2/src/main/java/bjc/utils/funcdata/IMap.java  | 11 +++++++++++
 2 files changed, 19 insertions(+)

(limited to 'BJC-Utils2/src/main/java/bjc/utils/funcdata')

diff --git a/BJC-Utils2/src/main/java/bjc/utils/funcdata/IList.java b/BJC-Utils2/src/main/java/bjc/utils/funcdata/IList.java
index 014c298..037b2b6 100644
--- a/BJC-Utils2/src/main/java/bjc/utils/funcdata/IList.java
+++ b/BJC-Utils2/src/main/java/bjc/utils/funcdata/IList.java
@@ -28,6 +28,14 @@ public interface IList<ContainedType> {
 	 */
 	boolean add(ContainedType item);
 
+	/**
+	 * Add all of the elements in the provided list to this list
+	 * 
+	 * @param items
+	 *            The list of items to add
+	 * @return True if every item was succesfully added to the list, false
+	 *         otherwise
+	 */
 	default boolean addAll(IList<ContainedType> items) {
 		return items.map(this::add).anyMatch((bl) -> bl == false);
 	}
diff --git a/BJC-Utils2/src/main/java/bjc/utils/funcdata/IMap.java b/BJC-Utils2/src/main/java/bjc/utils/funcdata/IMap.java
index 8522058..e69495a 100644
--- a/BJC-Utils2/src/main/java/bjc/utils/funcdata/IMap.java
+++ b/BJC-Utils2/src/main/java/bjc/utils/funcdata/IMap.java
@@ -73,6 +73,17 @@ public interface IMap<KeyType, ValueType> {
 	 */
 	ValueType get(KeyType key);
 
+	/**
+	 * Get a value from the map, and return a default value if the key
+	 * doesn't exist
+	 * 
+	 * @param key
+	 *            The key to attempt to retrieve
+	 * @param defaultValue
+	 *            The value to return if the key doesn't exist
+	 * @return The value associated with the key, or the default value if
+	 *         the key doesn't exist
+	 */
 	default ValueType getOrDefault(KeyType key, ValueType defaultValue) {
 		try {
 			return get(key);
-- 
cgit v1.2.3