summaryrefslogtreecommitdiff
path: root/BJC-Utils2/src/main/java/bjc/utils/data/Pair.java
blob: 5bd9d6306446a90b401642df7b016121ca43a950 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
package bjc.utils.data;

import java.util.function.BiConsumer;
import java.util.function.BiFunction;
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)
 */
public class Pair<L, R> {
	/**
	 * The left value of the pair
	 */
	private L	l;

	/**
	 * The right value of the pair
	 */
	private 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.
	 */
	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.
	 * @return A new pair containing the two modified values.
	 */
	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.
	 * @return The collapsed value.
	 */
	public <E> E merge(BiFunction<L, R, E> bf) {
		return bf.apply(l, r);
	}
	
	public void doWith(BiConsumer<L, R> bc) {
		bc.accept(l, r);
	}
}