Package g54327.humbug.model.Animals

Class Animal

java.lang.Object

g54327.humbug.model.Animals.Animal

Direct Known Subclasses:

Bumblebee, Butterfly, Grasshopper, Ladybird, Snail, Spider

public abstract class Animal
extends Object

Animal abstract Class

Since:

0.2.0

Version:

1.0.0

Author:

Andrew SASSOYE

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	onStar	Is on star (complete)
protected Position	positionOnBoard	Actual position on Board

Constructor Summary

Constructors

Constructor	Description
Animal()
Animal(Position positionOnBoard)	Animal constructor

Method Summary

Modifier and Type	Method	Description
static Animal	getAnimal(Animal[] animals, Position position)	Static method to find animal in array on position
Position	getPositionOnBoard()	this.positionOnBoard getter
boolean	isOnStar()	this.onStar getter
abstract Position	move(Board board, Direction direction, Animal[] animals)	Move animal in given direction
void	setOnStar(boolean onStar)	this.onStar setter
void	setPositionOnBoard(Position positionOnBoard)	this.positionOnBoard setter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

positionOnBoard

protected Position positionOnBoard

Actual position on Board

onStar

protected boolean onStar

Is on star (complete)

Constructor Detail

Animal

public Animal()

Animal

public Animal(Position positionOnBoard)

Animal constructor

Parameters:

positionOnBoard - Position of Animal on the Board

Method Detail

getAnimal

public static Animal getAnimal(Animal[] animals,
                               Position position)

Static method to find animal in array on position

Parameters:

animals - Animal array

position - position to find Animal in

Returns:

Animal if the animal is found, null if no animal found

move

public abstract Position move(Board board,
                              Direction direction,
                              Animal[] animals)

Move animal in given direction

Parameters:

board - Board

direction - Direction of movement

animals - Animal array

Returns:

Position of moved animal, null if fallen

getPositionOnBoard

public Position getPositionOnBoard()

this.positionOnBoard getter

Returns:

this.positionOnBoard

setPositionOnBoard

public void setPositionOnBoard(Position positionOnBoard)

this.positionOnBoard setter

Parameters:

positionOnBoard - new Position to set

isOnStar

public boolean isOnStar()

this.onStar getter

Returns:

true if on star, false if not

setOnStar

public void setOnStar(boolean onStar)

this.onStar setter

Parameters:

onStar - new boolean value of this.onStar