Package battleship.model.game

Class AttackReport

java.lang.Object

battleship.model.game.AttackReport

public class AttackReport
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AttackReport.HitResult	Hit result (Miss, nit or sunk).

Constructor Summary

Constructors

Constructor	Description
AttackReport(Ship ship, AttackReport.HitResult result, Point point, int fleetHealthRemaining, List<Point> points)

Method Summary

Modifier and Type	Method	Description
int	getFleetHealthRemaining()
static AttackReport.HitResult	getMissedResult()
List<Point>	getPointsOccupiedByShip()
Point	getPosition()	Get the position being attacked.
AttackReport.HitResult	getResult()
static AttackReport.HitResult	getResult(int health)
Ship	getShip()	Ship which was under attack

Methods inherited from class java.lang.Object

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

Constructor Details

AttackReport

public AttackReport(Ship ship,
 AttackReport.HitResult result,
 Point point,
 int fleetHealthRemaining,
 List<Point> points)

Method Details

getPointsOccupiedByShip

public List<Point> getPointsOccupiedByShip()

Returns:

List of points occupied by ship

getShip

public Ship getShip()

Ship which was under attack

Returns:

null if missed, ship type if sunk

getResult

public AttackReport.HitResult getResult()

Returns:

HitResult

getPosition

public Point getPosition()

Get the position being attacked.

Returns:

Point (x, y)

getFleetHealthRemaining

public int getFleetHealthRemaining()

Returns:

total health remaining.

getResult

public static AttackReport.HitResult getResult(int health)

Parameters:

health - health remaining of the ship.

Returns:

HitResult

getMissedResult

public static AttackReport.HitResult getMissedResult()

Returns:

HitResult.MISS