summaryrefslogtreecommitdiff
path: root/labs/lab01_pair/PairInterface.java
blob: b3d78fa0769e4659f23a156545952268e9d6e37c (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
public interface PairInterface<T1,T2>
{
	/**
	 * Gets the first element of this pair.
	 * @return the first element of this pair.
	 */
	public T1 fst();

	/**
	 * Gets the second element of this pair.
	 * @return the second element of this pair.
	 */
	public T2 snd();
	
	/**
	 * Sets the first element to aFirst.
	 * @param aFirst  the new first element
	 */
	public void setFst(T1 aFirst);
	
	/**
	 * Sets the second element to aSecond.
	 * @param aSecond  the new second element
	 */
	public void setSnd(T2 aSecond);
	
	/**
	 * Checks whether two pairs are equal. Note that the pair
	 * (a,b) is equal to the pair (x,y) if and only if a is
	 * equal to x and b is equal to y.
	 * 
	 * Note that if you forget to implement this method, your
	 * compiler will not complain since your class inherits this
	 * method from the class Object.
	 * 
	 * @return true if this pair is equal to aPair. Otherwise
	 * return false.
	 */	
	public boolean equals(Object otherObject);
	
	/**
	 * Generates a string representing this pair. Note that
	 * the String representing the pair (x,y) is "(x,y)". There
	 * is no whitespace unless x or y or both contain whitespace
	 * themselves.
	 * 
	 * Note that if you forget to implement this method, your
	 * compiler will not complain since your class inherits this
	 * method from the class Object.
	 * 
	 * @return a string representing this pair.
	 */	
	public String toString();
}