summaryrefslogtreecommitdiff
path: root/BJC-Utils2/src/main/java/bjc/utils
diff options
context:
space:
mode:
Diffstat (limited to 'BJC-Utils2/src/main/java/bjc/utils')
-rw-r--r--BJC-Utils2/src/main/java/bjc/utils/data/SingleSupplier.java16
-rw-r--r--BJC-Utils2/src/main/java/bjc/utils/gen/WeightedRandom.java2
2 files changed, 17 insertions, 1 deletions
diff --git a/BJC-Utils2/src/main/java/bjc/utils/data/SingleSupplier.java b/BJC-Utils2/src/main/java/bjc/utils/data/SingleSupplier.java
index f40ab29..ad00496 100644
--- a/BJC-Utils2/src/main/java/bjc/utils/data/SingleSupplier.java
+++ b/BJC-Utils2/src/main/java/bjc/utils/data/SingleSupplier.java
@@ -2,6 +2,16 @@ package bjc.utils.data;
import java.util.function.Supplier;
+/**
+ * A supplier that can only supply one value.
+ *
+ * Attempting to retrieve another value will cause an exception to be
+ * thrown.
+ *
+ * @author ben
+ *
+ * @param <T>
+ */
public class SingleSupplier<T> implements Supplier<T> {
private static long nextID = 0;
@@ -15,6 +25,12 @@ public class SingleSupplier<T> implements Supplier<T> {
// instantiation was, in case of duplicate initiations
private Exception instSite;
+ /**
+ * Create a new single supplier from an existing value
+ *
+ * @param supp
+ * The supplier to give a single value from
+ */
public SingleSupplier(Supplier<T> supp) {
source = supp;
diff --git a/BJC-Utils2/src/main/java/bjc/utils/gen/WeightedRandom.java b/BJC-Utils2/src/main/java/bjc/utils/gen/WeightedRandom.java
index e345424..4819ca2 100644
--- a/BJC-Utils2/src/main/java/bjc/utils/gen/WeightedRandom.java
+++ b/BJC-Utils2/src/main/java/bjc/utils/gen/WeightedRandom.java
@@ -116,4 +116,4 @@ public class WeightedRandom<E> {
public IList<IPair<Integer, E>> getValues() {
return probabilities.pairWith(results);
}
-} \ No newline at end of file
+}