EnumMap Iteration Order and Completeness
What you'll learn: How EnumMap maintains predictable iteration order and strategies for ensuring you've mapped all enum values.
Natural Enum Order Is Guaranteed
Unlike a regular HashMap where iteration order is essentially arbitrary, EnumMap guarantees that entries are always iterated in the order the enum constants were declared. This happens automatically because EnumMap uses an array internally, indexed by each enum's ordinal position.
Think of it like a classroom attendance sheet arranged by student ID numbers—when you go through the sheet, you always encounter students in the same sequence.
enum Status {
PENDING, APPROVED, REJECTED // declaration order
}
EnumMap<Status, String> statusMap = new EnumMap<>(Status.class);
statusMap.put(Status.REJECTED, "Denied");
statusMap.put(Status.PENDING, "Waiting");
statusMap.put(Status.APPROVED, "Confirmed");
// Iteration order: PENDING → APPROVED → REJECTED
for (Status status : statusMap.keySet()) {
System.out.println(status + ": " + statusMap.get(status));
}
Even though we inserted REJECTED first, iteration follows the enum declaration order.
Ensuring Completeness
A common requirement is making sure every enum value has a mapping. You can verify this by checking the map's size against the number of enum constants:
if (statusMap.size() != Status.values().length) {
System.out.println("Warning: Not all statuses are mapped!");
}
Or explicitly check for missing entries:
for (Status status : Status.values()) {
if (!statusMap.containsKey(status)) {
System.out.println("Missing mapping for: " + status);
}
}
This pattern is especially useful when adding new enum constants—you'll catch missing mappings immediately.
Key Takeaway: EnumMap guarantees iteration in enum declaration order, and you can validate completeness by comparing map size to the enum's total constant count.