summaryrefslogtreecommitdiff
path: root/BJC-Utils2/src/main/java/bjc/utils/data/Pair.java
diff options
context:
space:
mode:
Diffstat (limited to 'BJC-Utils2/src/main/java/bjc/utils/data/Pair.java')
-rw-r--r--BJC-Utils2/src/main/java/bjc/utils/data/Pair.java49
1 files changed, 34 insertions, 15 deletions
diff --git a/BJC-Utils2/src/main/java/bjc/utils/data/Pair.java b/BJC-Utils2/src/main/java/bjc/utils/data/Pair.java
index 14ac52d..11ce79c 100644
--- a/BJC-Utils2/src/main/java/bjc/utils/data/Pair.java
+++ b/BJC-Utils2/src/main/java/bjc/utils/data/Pair.java
@@ -5,47 +5,66 @@ import java.util.function.Function;
/**
* Holds a pair of values of two different types.
+ *
* @author ben
*
- * @param <L> The type of the thing held on the left (first)
- * @param <R> The type of the thing held on the right (second)
+ * @param <L>
+ * The type of the thing held on the left (first)
+ * @param <R>
+ * The type of the thing held on the right (second)
*/
public class Pair<L, R> {
+ /**
+ * The left value of the pair
+ */
public L l;
+
+ /**
+ * The right value of the pair
+ */
public R r;
/**
* Create a new pair that holds two nulls.
*/
public Pair() {
-
+
}
-
+
/**
* Create a new pair holding the specified values.
- * @param left The value to hold on the left.
- * @param right The value to hold on the right.
+ *
+ * @param left
+ * The value to hold on the left.
+ * @param right
+ * The value to hold on the right.
*/
public Pair(L left, R right) {
l = left;
r = right;
}
-
+
/**
* Create a new pair by applying the given functions to the left/right.
- * Does not change the internal contents of this pair.
- * @param lf The function to apply to the left value.
- * @param rf The function to apply to the right value.
+ * Does not change the internal contents of this pair.
+ *
+ * @param lf
+ * The function to apply to the left value.
+ * @param rf
+ * The function to apply to the right value.
* @return A new pair containing the two modified values.
*/
- public <L2, R2> Pair<L2, R2> apply(Function<L, L2> lf, Function<R, R2> rf) {
+ public <L2, R2> Pair<L2, R2> apply(Function<L, L2> lf,
+ Function<R, R2> rf) {
return new Pair<L2, R2>(lf.apply(l), rf.apply(r));
}
-
+
/**
- * Collapse this pair to a single value.
- * Does not change the internal contents of this pair.
- * @param bf The function to use to collapse the pair.
+ * Collapse this pair to a single value. Does not change the internal
+ * contents of this pair.
+ *
+ * @param bf
+ * The function to use to collapse the pair.
* @return The collapsed value.
*/
public <E> E merge(BiFunction<L, R, E> bf) {