com.vsegouin.mowitnow.controllers.interfaces

Interface MowerController

All Known Implementing Classes:

MainController

public interface MowerController

Created by v.segouin on 12/09/2016.

Method Summary

Modifier and Type	Method and Description
void	addMower(MapArea map, int abscissa, int ordinate) Add a new mower in the map at the x y coordinate.
void	addMower(MapArea map, Mower mower) Add a new mower in the map at the x y coordinate.
MapArea	createMap(int x, int y) Create a new empty map and add it to the mowerMapsList.
MapArea	executeFileCommands(List<String> fileContent) Create a new map, its mowers and their commands and execute it all.
void	executesCommands(Mower mower, char abbreviation) Make the mower executes the command.
void	executesCommands(Mower mower, MowerCommands command) Make the mower executes the command.
void	executesCommands(Mower mower, String commandLine) Make the mower execute the command line.
MapArea	fetchMapFromIndex(int index) Get the map located at the provided index.
Mower	fetchMowerFromCoordinates(MapArea map, int x, int y) Return the mower presents in the map at coordinate x y.
int	getMapIndex(MapArea map) Get the map index.
Map<MapArea,Map<Mower,String>>	getMapMowersList() Get the complete list of the Map and the mowers and their commands line.
int	getMowerIndex(MapArea map, Mower mower) Get the mower's addition number.
List<Map.Entry<Mower,MowerCommands>>	getProgramHistoric() Get the full historic of the program.
void	removeMower(MapArea map, int abscissa, int ordinate) Remove the mower from the map.
void	reset() Empty all the data.

Method Detail

fetchMowerFromCoordinates

Mower fetchMowerFromCoordinates(MapArea map,
                                int x,
                                int y)

Return the mower presents in the map at coordinate x y.

Parameters:

map - the map where to find the mower

x - the abscissa to seek

y - the ordinate to seek

Returns:

the found mower

addMower

void addMower(MapArea map,
              int abscissa,
              int ordinate)

Add a new mower in the map at the x y coordinate.

Parameters:

map - the map where to put the mower

abscissa - the abscissa to put the mower

ordinate - the ordinate to put the mower

addMower

void addMower(MapArea map,
              Mower mower)

Add a new mower in the map at the x y coordinate.

Parameters:

map - the map where to put the mower

mower - the mower to add

getMowerIndex

int getMowerIndex(MapArea map,
                  Mower mower)

Get the mower's addition number.

Parameters:

map - the map where the mower is supposed to be.

mower - the mower to find

Returns:

the mower's number

executesCommands

void executesCommands(Mower mower,
                      String commandLine)
               throws ImpossibleMowerCommandException

Make the mower execute the command line.

Parameters:

mower - the mower which wille execute the commands

commandLine - the commands to execute

Throws:

UnknownMowerCommandException - if asked command is null

ImpossibleMowerCommandException

executeFileCommands

MapArea executeFileCommands(List<String> fileContent)
                     throws ImpossibleMowerCommandException,
                            MowerInstructionFileException

Create a new map, its mowers and their commands and execute it all.

Parameters:

fileContent - the mower which will execute the command

Returns:

the created map

Throws:

MowerInstructionFileException - if file is bad formatted

UnknownMowerCommandException - if command doesn't exists or is null

ImpossibleMowerCommandException

executesCommands

void executesCommands(Mower mower,
                      char abbreviation)
               throws ImpossibleMowerCommandException

Make the mower executes the command.

Parameters:

mower - the mower which will execute the command

abbreviation - the character which correspond to a command

Throws:

UnknownMowerCommandException - if command doesn't exists

ImpossibleMowerCommandException

executesCommands

void executesCommands(Mower mower,
                      MowerCommands command)
               throws ImpossibleMowerCommandException

Make the mower executes the command.

Parameters:

mower - the mower which will execute the command

command - the command to execute

Throws:

UnknownMowerCommandException - if command doesn't exists

ImpossibleMowerCommandException

getProgramHistoric

List<Map.Entry<Mower,MowerCommands>> getProgramHistoric()

Get the full historic of the program.

Returns:

the full historic of the programs

getMapMowersList

Map<MapArea,Map<Mower,String>> getMapMowersList()

Get the complete list of the Map and the mowers and their commands line.

Returns:

the complete list of the Map and the mowers and their commands line

fetchMapFromIndex

MapArea fetchMapFromIndex(int index)

Get the map located at the provided index.

Parameters:

index - the map's index to get

Returns:

the found map

createMap

MapArea createMap(int x,
                  int y)

Create a new empty map and add it to the mowerMapsList.

Parameters:

x - the map's width

y - the map's height

Returns:

the created map

getMapIndex

int getMapIndex(MapArea map)

Get the map index.

Parameters:

map - the map to looks for

Returns:

the place number of the map in the list

reset

void reset()

Empty all the data.

removeMower

void removeMower(MapArea map,
                 int abscissa,
                 int ordinate)

Remove the mower from the map.

Parameters:

map - the map where to do the withdrawal

abscissa - the supposed abscissa of the mower

ordinate - the supposed ordinate of the mower