Add: JavaDoc for Artist class
This commit is contained in:
@@ -7,26 +7,52 @@ import it.polimi.ingsw.gc14.Model.Player;
|
|||||||
public class Artist extends Character {
|
public class Artist extends Character {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Creates an Artist character card with the specified era.
|
||||||
*
|
*
|
||||||
* param Era artist era
|
* @param Era the era of the Artist card
|
||||||
*/
|
*/
|
||||||
public Artist(int Era) {
|
public Artist(int Era) {
|
||||||
super(Era, CharacterType.ARTIST);
|
super(Era, CharacterType.ARTIST);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates an Artist character card with the specified Era and minimum number of players.
|
||||||
|
*
|
||||||
|
* @param Era the era of the Artist card
|
||||||
|
* @param nMin the minimum number of players required for the card
|
||||||
|
*/
|
||||||
public Artist(int Era,int nMin) {
|
public Artist(int Era,int nMin) {
|
||||||
super(Era, CharacterType.ARTIST,nMin);
|
super(Era, CharacterType.ARTIST,nMin);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the string representation of this Artist card.
|
||||||
|
*
|
||||||
|
* @return the string representation of this Artist card
|
||||||
|
*/
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public String toString() {
|
public String toString() {
|
||||||
return super.toString();
|
return super.toString();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates and returns a copy of this Artist card.
|
||||||
|
*
|
||||||
|
* @return a clone of this Artist card
|
||||||
|
*/
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public Character clone() {
|
public Character clone() {
|
||||||
return new Artist(getEra(), getNMin());
|
return new Artist(getEra(), getNMin());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Inserts this Artist card into the specified player's Artist collection.
|
||||||
|
*
|
||||||
|
* @param player the player who receives the card
|
||||||
|
*/
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void insert(Player player) {
|
public void insert(Player player) {
|
||||||
player.artists.add(this);
|
player.artists.add(this);
|
||||||
|
|||||||
Reference in New Issue
Block a user