app.model

Class CardGroup

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<Card>

app.model.CardGroup

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Card>, java.util.Collection<Card>, java.util.List<Card>, java.util.RandomAccess

Direct Known Subclasses:

Hand, Talon

public class CardGroup
extends java.util.ArrayList<Card>

The CardGroup class consists in a group of cards. It extends ArrayList class of jav.util package

Since:

v0.1

Version:

v1.0.2

Author:

Arthur, Alexandre

See Also:

ArrayList, Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
CardGroup(int NB_MAX_CARDS) Constructs a CardGroup

Method Summary

Modifier and Type	Method and Description
boolean	add(Card card) Add a card
boolean	addAll(java.util.Collection<? extends Card> cardList) Add all cards
java.lang.String	cardListToString() Display all the cards of a card group
boolean	equals(java.lang.Object o)
boolean	findInCardsList(java.lang.String nameToFind) Find a card by its name
Card	getInCardsList(java.lang.String nameToFind) Find a card by its name
int	getNbMaxCards()
int	hashCode()

Methods inherited from class java.util.ArrayList

add, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

CardGroup

public CardGroup(int NB_MAX_CARDS)
          throws CardGroupNumberException

Constructs a CardGroup

Parameters:

NB_MAX_CARDS - the max number of card a subclass of CardGroup can have

Throws:

CardGroupNumberException - if user tries to create too much cardGroup

Since:

v0.1

Method Detail

add

public boolean add(Card card)

Add a card

Specified by:

add in interface java.util.Collection<Card>

Specified by:

add in interface java.util.List<Card>

Overrides:

add in class java.util.ArrayList<Card>

Parameters:

card - the card which is added to card list

Since:

v0.1

addAll

public boolean addAll(java.util.Collection<? extends Card> cardList)

Add all cards

Specified by:

addAll in interface java.util.Collection<Card>

Specified by:

addAll in interface java.util.List<Card>

Overrides:

addAll in class java.util.ArrayList<Card>

Parameters:

cardList - the cards which are added to card list

Since:

v0.7

cardListToString

public java.lang.String cardListToString()

Display all the cards of a card group

Returns:

a string containing all CardGroup's cards name

Since:

v0.6

findInCardsList

public boolean findInCardsList(java.lang.String nameToFind)

Find a card by its name

Parameters:

nameToFind - the name searched

Returns:

a boolean indicating if card has been found

Since:

v0.6

getInCardsList

public Card getInCardsList(java.lang.String nameToFind)

Find a card by its name

Parameters:

nameToFind - the name searched

Returns:

the card if found

Since:

v0.6

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Collection<Card>

Specified by:

equals in interface java.util.List<Card>

Overrides:

equals in class java.util.AbstractList<Card>

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<Card>

Specified by:

hashCode in interface java.util.List<Card>

Overrides:

hashCode in class java.util.AbstractList<Card>

getNbMaxCards

public int getNbMaxCards()