Add: JavaDoc for Shaman class
This commit is contained in:
@@ -10,36 +10,63 @@ public class Shaman extends Character {
|
|||||||
private int icon;
|
private int icon;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Returns the icon value of this Shaman card.
|
||||||
*
|
*
|
||||||
* @return Shaman specific icon
|
* @return the icon value of this Shaman card
|
||||||
*/
|
*/
|
||||||
public int getIcon() {
|
public int getIcon() {
|
||||||
return icon;
|
return icon;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Creates a Shaman character card with the specified era and icon value.
|
||||||
*
|
*
|
||||||
* @param Era shaman era
|
* @param Era the era of the Shaman card
|
||||||
* @param icon shaman icon
|
* @param icon the icon value of the Shaman card
|
||||||
*/
|
*/
|
||||||
public Shaman(int Era, int icon) {
|
public Shaman(int Era, int icon) {
|
||||||
super(Era, CharacterType.SHAMAN);
|
super(Era, CharacterType.SHAMAN);
|
||||||
this.icon = icon;
|
this.icon = icon;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a Shaman character card with the specified era, icon value,
|
||||||
|
* and minimum number of players.
|
||||||
|
*
|
||||||
|
* @param Era the era of the Shaman card
|
||||||
|
* @param icon the icon value of the Shaman card
|
||||||
|
* @param nMin the minimum number of players required for the card
|
||||||
|
*/
|
||||||
public Shaman(int Era, int icon, int nMin) {
|
public Shaman(int Era, int icon, int nMin) {
|
||||||
super(Era, CharacterType.SHAMAN,nMin);
|
super(Era, CharacterType.SHAMAN,nMin);
|
||||||
this.icon = icon;
|
this.icon = icon;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the string representation of this Shaman card.
|
||||||
|
*
|
||||||
|
* @return the string representation of this Shaman card
|
||||||
|
*/
|
||||||
@Override
|
@Override
|
||||||
public String toString() {
|
public String toString() {
|
||||||
return super.toString() + "icon: " + String.valueOf(icon);
|
return super.toString() + "Icon: " + String.valueOf(icon);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates and returns a copy of this Shaman card.
|
||||||
|
*
|
||||||
|
* @return a clone of this Shaman card
|
||||||
|
*/
|
||||||
@Override
|
@Override
|
||||||
public Character clone() {
|
public Character clone() {
|
||||||
return new Shaman(getEra(), getIcon(), getNMin());
|
return new Shaman(getEra(), getIcon(), getNMin());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Inserts this Shaman card into the specified player's Shaman collection.
|
||||||
|
*
|
||||||
|
* @param player the player who receives the card
|
||||||
|
*/
|
||||||
@Override
|
@Override
|
||||||
public void insert(Player player)
|
public void insert(Player player)
|
||||||
{
|
{
|
||||||
|
|||||||
Reference in New Issue
Block a user