aboutsummaryrefslogtreecommitdiffstats
path: root/src/eu/equalparts/cardbase/containers/StandaloneCardContainer.java
blob: 1c4faf6a4bac06a9b4078a3832b063c6d195c836 (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
package eu.equalparts.cardbase.containers;

import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import com.fasterxml.jackson.annotation.JsonProperty;

import eu.equalparts.cardbase.card.Card;

/**
 * TODO fix comments
 * Holds actual card data in addition to the card counts in {@code ReferenceCardContainer}.
 * 
 * @author Eduardo Pedroni
 *
 */
public class StandaloneCardContainer extends ReferenceCardContainer {
	/**
	 * A map with card hashes as entry keys (calculated used {@code Card.hashCode()})
	 * and card objects as entry values.
	 */
	@JsonProperty private Map<Integer, Card> cardData = new HashMap<>();

	/**
	 * Returns a card from the cardbase by set code and number.
	 * If no such card is in the cardbase, returns null.
	 * 
	 * @param setCode the set to which the requested card belongs.
	 * @param number the requested card's set number.
	 * @return the requested {@code Card} or null if no card is found.
	 */
	public Card getCard(String setCode, String number) {
		return cardData.get(Card.makeHash(setCode, number));
	}
	
	/**
	 * This method is intended to allow iteration directly on the list of cards,
	 * while at the same time retaining control over the insert and remove procedures.
	 * The returned {@code List} is a copy of the list kept internally by {@code StandaloneCardContainer};
	 * modifying its structure is possible but will not affect the container instance from which it came.
	 * 
	 * @return an unmodifiable list of all the cards in the cardbase.
	 */
	public List<Card> getCards() {
		return new LinkedList<Card>(cardData.values());
	}
	
	@Override
	public void addCard(Card cardToAdd, int count) {
		super.addCard(cardToAdd, count);
		cardData.putIfAbsent(cardToAdd.hashCode(), cardToAdd);
	}

	@Override
	public int removeCard(Card cardToRemove, int count) {
		int removed = super.removeCard(cardToRemove, count);
		
		if (getCount(cardToRemove) <= 0) {
			cardData.remove(cardToRemove.hashCode());
		}
		
		return removed;
	}
}