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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
package eu.equalparts.cardbase.comparator;
import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.Comparator;
import java.util.function.BiFunction;
import eu.equalparts.cardbase.Cardbase;
import eu.equalparts.cardbase.comparator.SpecialFields.DirtyNumber;
import eu.equalparts.cardbase.comparator.SpecialFields.Rarity;
import eu.equalparts.cardbase.data.Card;
/**
* I'm new to this reflection business, so bear with me.
* <br><br>
* The idea here is to avoid having to write one class
* for each comparable field in {@code Card}. The program
* can dynamically instantiate them as cards are compared
* by different fields.
* <br><br>
* This class uses reflection to determine if the specified
* field is comparable with itself upon construction, and throws
* an {@code IllegalArgumentException} if that is not the case.
*
* @author Eduardo Pedroni
*
*/
@SuppressWarnings({"rawtypes", "unchecked"})
public class CardComparator implements Comparator<Card> {
public enum Order {
NATURAL, REVERSE;
}
/**
* The field being compared.
*/
private Field fieldToCompare;
/**
* The comparison delegate to use for the specified field.
*/
private BiFunction<Comparable, Comparable, Integer> selectedComparisonDelegate = this::defaultComparison;
/**
* Creates a new comparator for the specified field only. This class
* will only be constructed successfully if the field comes from
* {@code Card} and can be compared to itself (i.e. implements
* {@code Comparable<T>} where T is its own type.
* <br>
* For reference, {@code String} and {@code Integer} are both self comparable.
*
* @param fieldToCompare the field this comparator will use to compare cards, as declared in {@code Card}.
*/
public CardComparator(Field fieldToCompare) {
if (fieldToCompare.getDeclaringClass().equals(Card.class) &&
isSelfComparable(fieldToCompare.getType())) {
this.fieldToCompare = fieldToCompare;
// if annotated with a special comparator, set the comparison delegate here
for (Annotation annotation : fieldToCompare.getAnnotations()) {
if (annotation.annotationType() == DirtyNumber.class) {
this.selectedComparisonDelegate = ComparatorDelegates::compareDirtyNumber;
} else if (annotation.annotationType() == Rarity.class) {
this.selectedComparisonDelegate = ComparatorDelegates::compareRarity;
}
}
} else {
throw new IllegalArgumentException("The field provided is not valid.");
}
}
@Override
public int compare(Card o1, Card o2) {
/*
* we've already checked that the field is self comparable,
* so we are now free to cast to whatever type it is and compare.
*/
try {
Comparable field1 = (Comparable) fieldToCompare.get(o1);
Comparable field2 = (Comparable) fieldToCompare.get(o2);
// if either or both fields' values are null, skip delegation altogether since delegates are not required to deal with null values
if (field1 == null) {
if (field2 == null) {
return 0;
} else {
return -1;
}
} else if (field2 == null) {
return 1;
} else {
return selectedComparisonDelegate.apply(field1, field2);
}
} catch (IllegalArgumentException e) {
System.out.println("Error: class Card does not define field \"" + fieldToCompare.getName() + "\".");
if (Cardbase.DEBUG) e.printStackTrace();
} catch (IllegalAccessException e) {
System.out.println("Error: field " + fieldToCompare.getName() + " in Card is not visible.");
if (Cardbase.DEBUG) e.printStackTrace();
}
// fallback, this shouldn't happen
return 0;
}
/**
* The standard comparison operation, which uses the field's own {@code compareTo()}
* method.
*
* @param field1 the first object to be compared.
* @param field2 the second object to be compared.
* @return a negative integer, zero, or a positive integer as the
* first argument is less than, equal to, or greater than the
* second.
*/
private int defaultComparison(Comparable field1, Comparable field2) {
return field1.compareTo(field2);
}
/**
* Use reflection to determine if the specified class can be compared with itself.
*
* @param type the type to analyse.
* @return true if the type can be compared to itself using {@code compareTo()}, false otherwise.
*/
private boolean isSelfComparable(Class<?> type) {
// go through all interfaces implemented by this class
for (Type implementedInterface : type.getGenericInterfaces()) {
// check if any parameterised interface found is "Comparable"
if (implementedInterface instanceof ParameterizedType) {
ParameterizedType genericInterface = (ParameterizedType) implementedInterface;
if (genericInterface.getRawType().equals(Comparable.class)) {
// check that the type argument of comparable is the same as the field type itself
return genericInterface.getActualTypeArguments()[0].equals(type);
}
}
}
return false;
}
}
|
