From 015dbac96c05db2c99b00e1dcc2433d84453d160 Mon Sep 17 00:00:00 2001 From: Leonardo Brandenberger Date: Thu, 24 Mar 2022 14:36:48 +0100 Subject: [PATCH 1/5] added elements to README.md --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e3e5c8a..78d2a30 100644 --- a/README.md +++ b/README.md @@ -20,20 +20,25 @@ You will then be prompted to select a track file from the selection by entering > > 1=down-left
2=down
3=down-right
4=left
5=no acceleration
6=right
7=up-left
8=up
9=up-right
it is also possible to leave the game when it is your turn by entering 10 + Move List Strategy > For this strategy a predefined list of moves have to be given, the list may contain all allowed moves like mentioned in User Move Strategy +> > To create your own Move List strategy it needs to be located in /racetrack/moves and be named as *track_name*-car-*character_of_car*.txt and be a txt file. + Path Follow Move Strategy -> A list of point has to be given to the follow move strategy, the strategy will then calculate the route to cross each point in the given order. +> A list of points given in a txt file where on each lime a coordinate is placed like (X:24, Y:22) gets used to calculate a path which makes the car cross each point. +> > To create your own follow move strategy it needs to be located in /racetrack/moves and be named as *track_name*_points.txt and be a txt file. + Path Finder Strategy > The pathfinder Strategy Calculates a route itself and follows it direction fully automatically. The shown Track can be interpreted as following:
+'spaces' are part of the raceable track.
'#' is a Wall
'>,<,^,v' are finish line components
+'X' is shown if a car crashes at its crash location.
And every other character represents a car. - +> To create your own track it needs to be located inside /racetrack/tracks and be a txt file. ### Determining a winner The winner gets determined automatically.
The car that first passes the finish line (doing a complete round) is given the win, if all car except one crash the surviving car will be crowned as the winner.
The game will inform you of this, and you will have the option to quit the game or play another match. ## Branching Model -We choose a simple branching model where all starting features got a branch and where merged into the main branch, some branches who needed unfinished code to be completed where taken from the game branch but merged into the main at the end as well.
Since there was just one end product we abstained from using a development branch and merges where done straight into main. +We choose a simple branching model where all starting features got a branch and where merged into the main branch, some branches who needed unfinished code to be completed where taken from the game branch but merged into the main at the end as well.
Since there was just one end product we abstained from using a development branch and merges where done straight into main branch. ## Class Diagramm +![Classdiagramm of this program](/Klassendiagramm.drawio.svg) From bc0dd5236079d380d50c747b884cc555ab25728c Mon Sep 17 00:00:00 2001 From: Leonardo Brandenberger Date: Thu, 24 Mar 2022 14:38:08 +0100 Subject: [PATCH 2/5] added elements to README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 78d2a30..340f147 100644 --- a/README.md +++ b/README.md @@ -41,4 +41,4 @@ The winner gets determined automatically.
The car that first passes the fin We choose a simple branching model where all starting features got a branch and where merged into the main branch, some branches who needed unfinished code to be completed where taken from the game branch but merged into the main at the end as well.
Since there was just one end product we abstained from using a development branch and merges where done straight into main branch. ## Class Diagramm -![Classdiagramm of this program](/Klassendiagramm.drawio.svg) +![Classdiagramm of this program](/Klassendiagramm.drawio) From 31ec1e9e645b1cc95f6021f2beffeb7dafd34ed8 Mon Sep 17 00:00:00 2001 From: Leonardo Brandenberger Date: Thu, 24 Mar 2022 16:30:59 +0100 Subject: [PATCH 3/5] refactoring done in several classes --- src/main/java/ch/zhaw/pm2/racetrack/Car.java | 30 ++--- src/main/java/ch/zhaw/pm2/racetrack/Game.java | 1 - src/main/java/ch/zhaw/pm2/racetrack/Main.java | 11 +- .../ch/zhaw/pm2/racetrack/PositionVector.java | 4 +- .../java/ch/zhaw/pm2/racetrack/Track.java | 105 ++++++++++++------ .../ch/zhaw/pm2/racetrack/UserInterface.java | 42 ++++--- .../racetrack/strategy/MoveListStrategy.java | 5 +- .../strategy/PathFollowerMoveStrategy.java | 5 +- .../racetrack/strategy/UserMoveStrategy.java | 6 +- .../java/ch/zhaw/pm2/racetrack/CarTest.java | 2 +- .../java/ch/zhaw/pm2/racetrack/GameTest.java | 6 +- 11 files changed, 129 insertions(+), 88 deletions(-) diff --git a/src/main/java/ch/zhaw/pm2/racetrack/Car.java b/src/main/java/ch/zhaw/pm2/racetrack/Car.java index 8e9255e..da73693 100644 --- a/src/main/java/ch/zhaw/pm2/racetrack/Car.java +++ b/src/main/java/ch/zhaw/pm2/racetrack/Car.java @@ -3,14 +3,12 @@ package ch.zhaw.pm2.racetrack; import ch.zhaw.pm2.racetrack.given.CarSpecification; import ch.zhaw.pm2.racetrack.strategy.MoveStrategy; -import java.util.Vector; - /** * Class representing a car on the racetrack. * Uses {@link PositionVector} to store current position on the track grid and current velocity vector. - * Each car has an identifier character which represents the car on the race track board. + * Each car has an identifier character which represents the car on the racetrack board. * Also keeps the state, if the car is crashed (not active anymore). The state can not be changed back to uncrashed. - * The velocity is changed by providing an acelleration vector. + * The velocity is changed by providing an acceleration vector. * The car is able to calculate the endpoint of its next position and on request moves to it. */ public class Car implements CarSpecification { @@ -46,7 +44,8 @@ public class Car implements CarSpecification { /** * Constructor for class Car - * @param id unique Car identification + * + * @param id unique Car identification * @param position initial position of the Car */ public Car(char id, PositionVector position) { @@ -59,16 +58,16 @@ public class Car implements CarSpecification { * * @return id of the car. */ - public char getID(){ + public char getID() { return id; } public void increaseWinPoints() { - winPoints ++; + winPoints++; } public void deductWinPoints() { - winPoints --; + winPoints--; } public int getWinPoints() { @@ -80,9 +79,10 @@ public class Car implements CarSpecification { * * @return velocity current velocity of the car. */ - public PositionVector getVelocity(){ + public PositionVector getVelocity() { return velocity; } + /** * Set this Car position directly, regardless of current position and velocity. * This should only be used by the game controller in rare cases to set the crash or winning position. @@ -95,8 +95,7 @@ public class Car implements CarSpecification { public void setPosition(final PositionVector position) { if (position.getX() < 0 || position.getY() < 0) { throw new IllegalArgumentException(); - } - else { + } else { this.position = position; } } @@ -109,7 +108,7 @@ public class Car implements CarSpecification { */ @Override public PositionVector nextPosition() { - return new PositionVector(position.getX() + velocity.getX(),position.getY() + velocity.getY()); + return new PositionVector(position.getX() + velocity.getX(), position.getY() + velocity.getY()); } /** @@ -123,11 +122,10 @@ public class Car implements CarSpecification { */ @Override public void accelerate(PositionVector.Direction acceleration) { - if(acceleration.vector.getX() < -1 || acceleration.vector.getX() > 1|| + if (acceleration.vector.getX() < -1 || acceleration.vector.getX() > 1 || acceleration.vector.getY() < -1 || acceleration.vector.getY() > 1) { throw new IllegalArgumentException(); - } - else { + } else { velocity = new PositionVector(velocity.getX() + acceleration.vector.getX(), velocity.getY() + acceleration.vector.getY()); } @@ -161,6 +159,7 @@ public class Car implements CarSpecification { /** * Set move strategy + * * @param moveStrategy Strategy to be implemented */ public void setMoveStrategy(MoveStrategy moveStrategy) { @@ -169,6 +168,7 @@ public class Car implements CarSpecification { /** * Get current move strategy + * * @return MoveStrategy */ public MoveStrategy getMoveStrategy() { diff --git a/src/main/java/ch/zhaw/pm2/racetrack/Game.java b/src/main/java/ch/zhaw/pm2/racetrack/Game.java index 265cd15..1486983 100644 --- a/src/main/java/ch/zhaw/pm2/racetrack/Game.java +++ b/src/main/java/ch/zhaw/pm2/racetrack/Game.java @@ -275,7 +275,6 @@ public class Game implements GameSpecification { } - private void calculateWinner(PositionVector start, PositionVector finish, int carIndex) { List path = calculatePath(start, finish); for (PositionVector point : path) { diff --git a/src/main/java/ch/zhaw/pm2/racetrack/Main.java b/src/main/java/ch/zhaw/pm2/racetrack/Main.java index aec65bd..83bf6d8 100644 --- a/src/main/java/ch/zhaw/pm2/racetrack/Main.java +++ b/src/main/java/ch/zhaw/pm2/racetrack/Main.java @@ -1,6 +1,5 @@ package ch.zhaw.pm2.racetrack; -import java.io.FileNotFoundException; import java.util.ArrayList; import java.util.List; @@ -17,19 +16,17 @@ public class Main { optionsNewGame.add("exit"); optionsNewGame.add("new game"); String winnerText; - if(winner == null){ + if (winner == null) { winnerText = "There was no winner."; - } - else { + } else { winnerText = "The Winner was Car " + winner; } int selectedOption = userInterface.selectOption(winnerText + "\nStart new Game?", optionsNewGame); - if(selectedOption == 0) { + if (selectedOption == 0) { userInterface.quit("Thank you and goodbye\npress enter to close the application."); break; } - } - else { + } else { userInterface.quit("The initialisation of the game failed. Press enter to close the application."); break; } diff --git a/src/main/java/ch/zhaw/pm2/racetrack/PositionVector.java b/src/main/java/ch/zhaw/pm2/racetrack/PositionVector.java index 10209a3..4f3eafe 100644 --- a/src/main/java/ch/zhaw/pm2/racetrack/PositionVector.java +++ b/src/main/java/ch/zhaw/pm2/racetrack/PositionVector.java @@ -7,8 +7,8 @@ package ch.zhaw.pm2.racetrack; * Created by mach 21.01.2020 */ public final class PositionVector { - private int x; // horizontal component (position / velocity) - private int y; // vertical component (position / velocity) + private final int x; // horizontal component (position / velocity) + private final int y; // vertical component (position / velocity) /** * Enum representing a direction on the track grid. diff --git a/src/main/java/ch/zhaw/pm2/racetrack/Track.java b/src/main/java/ch/zhaw/pm2/racetrack/Track.java index e0a6ff4..79f5e70 100644 --- a/src/main/java/ch/zhaw/pm2/racetrack/Track.java +++ b/src/main/java/ch/zhaw/pm2/racetrack/Track.java @@ -3,7 +3,10 @@ package ch.zhaw.pm2.racetrack; import ch.zhaw.pm2.racetrack.given.ConfigSpecification; import ch.zhaw.pm2.racetrack.given.TrackSpecification; -import java.io.*; +import java.io.File; +import java.io.FileInputStream; +import java.io.FileNotFoundException; +import java.nio.charset.StandardCharsets; import java.util.ArrayList; import java.util.List; import java.util.Scanner; @@ -57,8 +60,8 @@ import java.util.Scanner; public class Track implements TrackSpecification { public static final char CRASH_INDICATOR = 'X'; - private List track; - private List cars; + private final List track; + private final List cars; private final List finishLine; private ConfigSpecification.SpaceType finishTyp; @@ -85,13 +88,17 @@ public class Track implements TrackSpecification { * @throws FileNotFoundException if the FilePath is invalid. */ private void readFile(File trackFile) throws FileNotFoundException { - Scanner scanner = new Scanner(new FileInputStream(trackFile),"UTF-8"); + Scanner scanner = new Scanner(new FileInputStream(trackFile), StandardCharsets.UTF_8); while (scanner.hasNextLine()) { track.add(scanner.nextLine()); } } - + /** + * Goes through the track ArrayList and determines the locations of each cars and initializes them at the location. + * + * @throws InvalidTrackFormatException is thrown if a car is found more than once inside the track. + */ private void addCars() throws InvalidTrackFormatException { ConfigSpecification.SpaceType[] spaceTypes = ConfigSpecification.SpaceType.values(); List allSpaceTypesAsChar = new ArrayList<>(); @@ -101,23 +108,26 @@ public class Track implements TrackSpecification { allSpaceTypesAsChar.add(spaceType.getValue()); } - - for (int j = 0; j < track.size(); j++) { - String line = track.get(j); - for (int i = 0; i < line.length(); i++) { - char possibleCarChar = line.charAt(i); + for (int yPosition = 0; yPosition < track.size(); yPosition++) { + String line = track.get(yPosition); + for (int xPosition = 0; xPosition < line.length(); xPosition++) { + char possibleCarChar = line.charAt(xPosition); if (!allSpaceTypesAsChar.contains(possibleCarChar)) { if (usedSymbolForCar.contains(possibleCarChar)) { throw new InvalidTrackFormatException(); } usedSymbolForCar.add(possibleCarChar); - cars.add(new Car(possibleCarChar, new PositionVector(i, j))); + cars.add(new Car(possibleCarChar, new PositionVector(xPosition, yPosition))); } } } } - + //TODO: THIS + /** + * + * @throws InvalidTrackFormatException + */ private void findFinish() throws InvalidTrackFormatException { for (int i = 0; i < track.size(); i++) { String line = track.get(i); @@ -141,6 +151,12 @@ public class Track implements TrackSpecification { } } + /** + * Method to find the PositionVector of a chosen character + * + * @param symbol char that we are looking for on the track + * @return the PositionVector of the desired char + */ private PositionVector findChar(char symbol) { PositionVector vector = null; for (int i = 0; i < track.size(); i++) { @@ -154,37 +170,47 @@ public class Track implements TrackSpecification { return vector; } + /** + * Method that places a character at a chosen position + * + * @param positionVector position where char will be placed + * @param symbol char that should be placed at desired position + */ private void drawCharOnTrackIndicator(PositionVector positionVector, char symbol) { String line = track.get(positionVector.getY()); line = line.substring(0, positionVector.getX()) + symbol + line.substring(positionVector.getX() + 1); track.remove(positionVector.getY()); track.add(positionVector.getY(), line); } - + //TODO: check if this method is okay and needed + /** + * Determines if a location is valid PositionVector inside the track + * + * @param positionVector of location that has to be checked + * @throws PositionVectorNotValid if the PositionVector does not lie on the track. + */ private void isPositionVectorOnTrack(PositionVector positionVector) throws PositionVectorNotValid { - try{ + try { track.get(positionVector.getY()).charAt(positionVector.getX()); - }catch (IndexOutOfBoundsException e) { + } catch (IndexOutOfBoundsException e) { throw new PositionVectorNotValid(); } } - /** - * @return all Cars - */ - public List getCars() { - return cars; - } /** - * @return finishLine + * Method that returns the finishline as a List + * + * @return finishLine List */ public List getFinishLine() { return finishLine; } /** - * @return the track + * Returns the whole Track as List of Strings + * + * @return track as List of Strings */ public List getTrack() { return track; @@ -203,7 +229,7 @@ public class Track implements TrackSpecification { } /** - * This class does change the Position of the car only in the track. + * This Method does change the Position of the car inside the track object. * * @param carIndex of the current car */ @@ -213,8 +239,8 @@ public class Track implements TrackSpecification { drawCharOnTrackIndicator(carPositionVector, ConfigSpecification.SpaceType.TRACK.getValue()); //Redraw finishline if Car was on finish-line Position - for(PositionVector finishLinePositionVector : finishLine){ - if(finishLinePositionVector.equals(carPositionVector)){ + for (PositionVector finishLinePositionVector : finishLine) { + if (finishLinePositionVector.equals(carPositionVector)) { drawCharOnTrackIndicator(carPositionVector, finishTyp.getValue()); } } @@ -225,10 +251,10 @@ public class Track implements TrackSpecification { } /** - * This Method will check if the Car could crash at the specific position + * This Method will check if the Car would crash at the specific position * - * @param positionVector the position to check if the car could crash - * @return true if car would crash. Else false. + * @param positionVector the position to check if the car would crash + * @return true if crash otherwise false */ public boolean willCrashAtPosition(int carIndex, PositionVector positionVector) throws PositionVectorNotValid { isPositionVectorOnTrack(positionVector); //TODO: remove this line? Or Method? @@ -242,12 +268,12 @@ public class Track implements TrackSpecification { } /** - * This Method will make the Car Crash. In Track and in the Car Object + * This Method will mark the Car as crashed inside the track and the car Object. * - * @param carIndex representing current Car - * @param crashPositionVector where the Crash did happen + * @param carIndex of car that will be marked as crashed + * @param crashPositionVector of the location of the crash */ - public void carDoesCrash(int carIndex, PositionVector crashPositionVector) throws PositionVectorNotValid{ + public void carDoesCrash(int carIndex, PositionVector crashPositionVector) throws PositionVectorNotValid { isPositionVectorOnTrack(crashPositionVector); //TODO: remove this line? and Method? PositionVector currentCarPosition = getCarPos(carIndex); drawCharOnTrackIndicator(new PositionVector(currentCarPosition.getX(), currentCarPosition.getY()), ConfigSpecification.SpaceType.TRACK.getValue()); @@ -262,7 +288,7 @@ public class Track implements TrackSpecification { * If the location is outside the track bounds, it is considered a wall. * * @param position The coordinates of the position to examine - * @return The type of track position at the given location + * @return The type of space at the desired position */ @Override public Config.SpaceType getSpaceType(PositionVector position) { @@ -279,9 +305,9 @@ public class Track implements TrackSpecification { } /** - * Return the number of cars. + * Return the number of cars that are located in a track * - * @return Number of cars + * @return number of cars as int */ @Override public int getCarCount() { @@ -355,6 +381,13 @@ public class Track implements TrackSpecification { return currentSpace.getValue(); } + /** + * Determines all points that lie between the two position vectors including the endpoint VectorPosition using the Bresenham algorithm. + * + * @param startPosition PositionVector of the finish coordinate + * @param endPosition PositionVector of the start coordinate + * @return ArrayList containing PositionVectors of all position that are between the start and finish including the finish position. + */ public ArrayList calculatePointsOnPath(PositionVector startPosition, PositionVector endPosition) { ArrayList pathList = new ArrayList<>(); // Use Bresenham's algorithm to determine positions. diff --git a/src/main/java/ch/zhaw/pm2/racetrack/UserInterface.java b/src/main/java/ch/zhaw/pm2/racetrack/UserInterface.java index 96a8c04..b6c9e02 100644 --- a/src/main/java/ch/zhaw/pm2/racetrack/UserInterface.java +++ b/src/main/java/ch/zhaw/pm2/racetrack/UserInterface.java @@ -6,13 +6,20 @@ import org.beryx.textio.TextTerminal; import java.util.List; +/** + * Class representing the Userinterface. + * Used to get inputs from users via textio. + * + * @author Roman Schenk + */ public class UserInterface { private final TextIO textIO; private final TextTerminal textTerminal; /** - * Opens a new Terminal Window and prints the welcome Text + * Opens a new Terminal Window and prints the welcome Text. + * * @param welcomeText The Text which will be printed after the windows is opened. */ public UserInterface(String welcomeText) { @@ -24,6 +31,7 @@ public class UserInterface { /** * Prints the given Text in textTerminal + * * @param text The Text which should be printed. */ public void printInformation(String text) { @@ -31,23 +39,25 @@ public class UserInterface { } /** - * asks the user to choose one of the options given. - * @param text Text which is printed befor the options are printed. Example: "Select Track file:" + * Method which asks the user to choose one of the options given. + * + * @param text Text which is printed before the options are printed. Example: "Select Track file:" * @param options List with the options which can be selected. * @return the list index of the selected option */ public int selectOption(String text, List options) { textTerminal.println(text + ":"); - for(int option = 0; option < options.size(); option ++) { - textTerminal.println(" " + (option + 1) + ": " + options.get(option)); + for (int option = 0; option < options.size(); option++) { + textTerminal.println(" " + (option + 1) + ": " + options.get(option)); } return textIO.newIntInputReader().withMinVal(1).withMaxVal(options.size()).read("Enter your choice: ") - 1; } /** - * gives information which player's turn it is and asks for the direction to accelerate + * Gives information which player is at turn and asks for the direction to accelerate or quit the game. + * * @param playingCarIndex the index of the player - * @param playingCarID the ID of the player + * @param playingCarID the ID of the player * @return the direction which is selected by the player. If null -> quit game */ public PositionVector.Direction selectDirection(int playingCarIndex, char playingCarID) { @@ -70,7 +80,8 @@ public class UserInterface { } /** - * returns the the associated direction Object + * Method which returns the associated direction Object. + * * @param number the number which was typed by the user * @return the associated direction. If null -> unknown number */ @@ -90,22 +101,21 @@ public class UserInterface { } /** - * prints the given Track in the terminal + * Method to print the given Track in the terminal + * * @param track the track which should be printed */ public void printTrack(Track track) { - textTerminal.println(track.toString()); + textTerminal.println(track.toString()); } /** - * Method to dispose the Textterminal - * @param text OUtput Text + * Method to dispose of the Textterminal + * + * @param text Output Text */ - public void quit(String text){ + public void quit(String text) { textIO.newStringInputReader().withMinLength(0).read(text); textTerminal.dispose(); } - - - } diff --git a/src/main/java/ch/zhaw/pm2/racetrack/strategy/MoveListStrategy.java b/src/main/java/ch/zhaw/pm2/racetrack/strategy/MoveListStrategy.java index 3de3f23..4966184 100644 --- a/src/main/java/ch/zhaw/pm2/racetrack/strategy/MoveListStrategy.java +++ b/src/main/java/ch/zhaw/pm2/racetrack/strategy/MoveListStrategy.java @@ -5,13 +5,14 @@ import ch.zhaw.pm2.racetrack.PositionVector.Direction; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; +import java.nio.charset.StandardCharsets; import java.util.ArrayList; import java.util.List; import java.util.Scanner; public class MoveListStrategy implements MoveStrategy { - private List moveList; + private final List moveList; private int pointer; public MoveListStrategy(String path) throws FileNotFoundException{ @@ -21,7 +22,7 @@ public class MoveListStrategy implements MoveStrategy { } private void readFile(File trackFile) throws FileNotFoundException { - Scanner scanner = new Scanner(new FileInputStream(trackFile), "UTF-8"); + Scanner scanner = new Scanner(new FileInputStream(trackFile), StandardCharsets.UTF_8); Direction[] directions = Direction.values(); while (scanner.hasNextLine()) { String line = scanner.nextLine(); diff --git a/src/main/java/ch/zhaw/pm2/racetrack/strategy/PathFollowerMoveStrategy.java b/src/main/java/ch/zhaw/pm2/racetrack/strategy/PathFollowerMoveStrategy.java index 807ddc8..f1ab6a8 100644 --- a/src/main/java/ch/zhaw/pm2/racetrack/strategy/PathFollowerMoveStrategy.java +++ b/src/main/java/ch/zhaw/pm2/racetrack/strategy/PathFollowerMoveStrategy.java @@ -6,6 +6,7 @@ import ch.zhaw.pm2.racetrack.PositionVector.Direction; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; +import java.nio.charset.StandardCharsets; import java.util.ArrayList; import java.util.Scanner; @@ -25,7 +26,7 @@ public class PathFollowerMoveStrategy implements MoveStrategy { /** * List of all points on the path. */ - private ArrayList pointList; + private final ArrayList pointList; /** * The index of the next point on the path. */ @@ -51,7 +52,7 @@ public class PathFollowerMoveStrategy implements MoveStrategy { * @throws FileNotFoundException If the file with the given path does not exist. */ public void readFile(File trackFile) throws FileNotFoundException { - Scanner scanner = new Scanner(new FileInputStream(trackFile), "UTF-8"); + Scanner scanner = new Scanner(new FileInputStream(trackFile), StandardCharsets.UTF_8); while (scanner.hasNextLine()) { String line = scanner.nextLine(); String[] coordinates = line.split("(\\(X:|, Y:|\\))"); diff --git a/src/main/java/ch/zhaw/pm2/racetrack/strategy/UserMoveStrategy.java b/src/main/java/ch/zhaw/pm2/racetrack/strategy/UserMoveStrategy.java index 06589ff..d0755aa 100644 --- a/src/main/java/ch/zhaw/pm2/racetrack/strategy/UserMoveStrategy.java +++ b/src/main/java/ch/zhaw/pm2/racetrack/strategy/UserMoveStrategy.java @@ -7,9 +7,9 @@ import ch.zhaw.pm2.racetrack.UserInterface; * Let the user decide the next move. */ public class UserMoveStrategy implements MoveStrategy { - private UserInterface userInterface; - private int carIndex; - private char carID; + private final UserInterface userInterface; + private final int carIndex; + private final char carID; public UserMoveStrategy(UserInterface userInterface, int carIndex, char carID) { this.userInterface = userInterface; diff --git a/src/test/java/ch/zhaw/pm2/racetrack/CarTest.java b/src/test/java/ch/zhaw/pm2/racetrack/CarTest.java index ebac56c..6a94e09 100644 --- a/src/test/java/ch/zhaw/pm2/racetrack/CarTest.java +++ b/src/test/java/ch/zhaw/pm2/racetrack/CarTest.java @@ -101,7 +101,7 @@ class CarTest { @Test void movement() { // add all possible directions in a List - List directions = Arrays.asList(PositionVector.Direction.values()); + PositionVector.Direction[] directions = PositionVector.Direction.values(); //position shouldn't be changed because velocity should be 0. car.move(); diff --git a/src/test/java/ch/zhaw/pm2/racetrack/GameTest.java b/src/test/java/ch/zhaw/pm2/racetrack/GameTest.java index 0c1dea3..908375c 100644 --- a/src/test/java/ch/zhaw/pm2/racetrack/GameTest.java +++ b/src/test/java/ch/zhaw/pm2/racetrack/GameTest.java @@ -20,9 +20,9 @@ class GameTest { private Game game; private Track track; - private String TRACK_FILE_PATH = ".\\tracks\\challenge.txt"; - private int CAR_INDEX_ONE = 0; - private int CAR_INDEX_TWO = 1; + private final String TRACK_FILE_PATH = ".\\tracks\\challenge.txt"; + private final int CAR_INDEX_ONE = 0; + private final int CAR_INDEX_TWO = 1; /** * This nested Class tests if the game gets initiatet correctly From a143a9c7d764646a7ccf1f7994cc1217cda904c2 Mon Sep 17 00:00:00 2001 From: Andrin Fassbind Date: Thu, 24 Mar 2022 16:50:18 +0100 Subject: [PATCH 4/5] refactoring several classes --- Klassendiagramm.drawio | 2 +- src/main/java/ch/zhaw/pm2/racetrack/Game.java | 120 ++++++++++-------- .../racetrack/InvalidFileFormatException.java | 1 + src/main/java/ch/zhaw/pm2/racetrack/Main.java | 3 +- .../pm2/racetrack/PositionVectorNotValid.java | 9 -- .../PositionVectorNotValidException.java | 9 ++ .../java/ch/zhaw/pm2/racetrack/Track.java | 14 +- .../racetrack/given/GameSpecification.java | 6 +- .../java/ch/zhaw/pm2/racetrack/GameTest.java | 39 +++--- .../java/ch/zhaw/pm2/racetrack/TrackTest.java | 23 ++-- 10 files changed, 123 insertions(+), 103 deletions(-) delete mode 100644 src/main/java/ch/zhaw/pm2/racetrack/PositionVectorNotValid.java create mode 100644 src/main/java/ch/zhaw/pm2/racetrack/PositionVectorNotValidException.java diff --git a/Klassendiagramm.drawio b/Klassendiagramm.drawio index afde28c..99e08e5 100644 --- a/Klassendiagramm.drawio +++ b/Klassendiagramm.drawio @@ -1 +1 @@ -7Vtbd6I6GP01PraLi7c+qr3MzOn0OGNPe16jRMgxEE+Itc6vny8QQExVaGVorWt1rZKPkED2zpedDTbsgf98w9Hc+84cTBuW4Tw37MuGZZnwB/9kZBVHOu1mHHA5cVSlLDAiv7AKGiq6IA4OcxUFY1SQeT44YUGAJyIXQ5yzZb7alNF8r3PkYi0wmiCqRx+JI7w42rU6WfwLJq6X9Gy2L+IzPkoqqycJPeSw5VrIvmrYA86YiI/85wGmcvCScXn8unqkt7P2zbcf4f/on/5f93cPZ3Fj12UuSR+B40C8uulfs+n1l4fmf//Oh9c/lsZNb/ztTF1iPCG6UOM1xDxkgXpisUqGMVwSn6IASv0pC8RInYFB6CNK3ACOJ3B3mEPgCXNBAIGeOiHYHKITj1DnFq3YQj5DKNBklpT6HuPkFzSLKJwyIQCnuVBkstq5GiN5JYQNiHIcQp1hMjBmGrpFoVB1JoxSNA/JOLphWcVH3CVBnwnB/KQhtggc7KhSinRUEJzNUu7I6wvCoWCTo4Gf18io4LnBzMeCr6CKOttVaKiZ1lLFZUZbs61i3jpl7a6aLmqquGnLaWc/YWqhwIUhSHuz7Hx3ZrNgf4BHrjtEAfYACdyXgxiukxAO1h40C0XULEFTU6PpHfKxRlIYZ7FGSIqnYisdwzmakMC9jepcNrPIT/WkMsTg2imNqOARx8FBRBWBBIrZJPkxZyQQ0VC0+vAHAzYwzluNFtzQAMpmVoY/WZ2LAQuAVYhE9MFA1SWWdH2BWDsn7X5irfKIlUV2nUg5SMviZ+lpxmOBJOPdwh9D0jg2JHfkE0/4VB1WhXfLqhlvW8P7ykdEXtZzHMjQ4QnwgwLe6dYMeFMDXEOYkkg9qNEwX1xZ98DvA5CyuQTve0mHyzNT44Stc8J+AX+KxpgOWUgEYbJ9Htfd4EVdWds0msVQ3bH8vwnUlp61F3zioVAmbhBdMxje6OgI53NloJp15+a2hupILBz5mAU1v3HS/JVpfrtbreg37Vf2V4Po72wn6rHKxoJZp12YZe9lA9DVsOzB3UvrxjK+w0pydEgeVA+Wxrv2DcDFSQ8eHNSiIr8qOWjqZuFXSPzGFaARrbSWcc9kOeBMtnZkM3pdAjWrwrhbd6I2davtBssVd4R9EiAuAb9HM6w7xB8d36ogrV/xJzewKxvjwOnJty1QGlMmxXYfQkqNm0ZcvCY0Wbn2yOX88ocdFydTB9MxW15lgX4UgBMJU0qL7ZDBrhTvhwy2Fy4usJmTd7sT2JeA5JgiQZ7yL512aPOhJG6myy0jr8stw843ET+kumr9LU/ZhuJR0Bo6mFOvW39DzqY4DJku108bzOo3mLb5yh1fx9hL4hc2mHazQHed97HBNHXXcoQoUhn3E65t6eT9OBtLUzcpNfQ++06jPKxF94+VbTV0k/JTKZYEsXctWTYXls4rJcvmCmV1Nu6lasmiG43b3lKeBEv1gqW1oSAKf5Zi7lhjtguWVivf3bv+DEa3UUeCY6y/uvksgqVTmF3vRrDo1uiAiOOTnAc1wMvjXLsDnnw1mpurkB1OQB8W6No/fbF0xxSEvVzELWPAnBPgBwa88Gcx1SGu+6kDGBNxhMZB3VjbrxRjh8Na9zM1kD+9v1Ae11ZBGVaVwWDp1t8DQOQc4wJdHYrt2jOx7v79vRDzhXQXevJV5a2cBydECyN6UXu+Lef8sXk01uW8vdQWNOt3+tTY7jX6Eiz3On0KZ0mlnIuibuiNpp+98b2ieWHlmyhq+m26PFpDW0w/raGzzRdOG+2w6TTElfiGlu4bGufnCfAZXSMvbi0R7Ek7Y+XIxWt4H01mbsTfAaOMw/mAZf6jMrut4jkhmV/q55bqthrpjxyL+3Rnb2RUQsw/BpdunhXHKtFPHxWsw8z+5JPcPw6d7plReAq5wKOt3ueaHN9EVVfBRQz8VKPvxrqUif5GYmgE2MaV4uvExWGYknyevmHiv4UrUMx+bB1Xz36ybl/9Bg== \ No newline at end of file +7V1Zd5vIEv41Pkd5UI4akJAetcSJ59qJJ3a2p3uw1JaYIFoDyLLy66ebTUAXAi00MjAPE9MCLf1V1/J1VfWVPF6+frS01eKOzLBxJXVmr1fy5EqSJLmj0n/YyNYbQYoieSNzS5/5Y7uBB/0P9gc7/uhan2E7dqNDiOHoq/jglJgmnjqxMc2yyCZ+2zMx4p+60uaYG3iYagY/+kOfOQt/tNdVdi98wvp8EXw06g28V5ZacLf/U+yFNiObyJD84UoeW4Q43l/L1zE22PQFE/PjZvvDuP3d+/jX3/a/2rfR/x4/f297b3Z9yCPhb7Cw6Rz91n9+P19/+q7883N1f/33pvNx+PRX23+k86IZa3/CPmpL7P9eZxvMor3Rl4Zm0qvRMzGdB/8VOgUjzdDnJv17Sr8btujAC7YcnQIw9F9wyIqOThe6MbvVtmTNfoHtaNPfwdVoQSz9D31bzaAvITpAX7YcX5akXuyOB/YkHe7QUQvb9J77YFpQOHSr2Y5/z5QYhray9Sf3C7Nblpo1180RcRyyDN6IrM0ZnvlXIc7uhWOR36HosOdzguGDxmYDv0Zk0QfnIyZL7Fhbeov/at9/wl9pgdRtdlIrD/yxRURgJdUf1PyVMg/fOfywr3RlaeacTkH4aXRpxz4OKfznoR70eb34x2kGhd3UHDxik2hHRZD+EfmhuyFXMA8QUoUTUk5ADd0VzoWz3MlQErhAUg387AByutRnM/Z2I3ulTXVz/sjkdtJGu5Fb98GJvBv56s+L7AqRozmaJ2dMcgztCRv3xNYdnbD3t7x7Ryuim447ed3RVXfijljOmJj0G2u6K1OYyu8GMxkGpG3vOs6Wtm0cxizxkpV06YrhvAfUT/2lNLozfv4aEqI/f/u5GbbttowAVEdM+7TWNrZumDZ51qb0peG36PU7Dnv6ix0I+zExCFVIE5N4iks3jMRQXonYLHQHP6zcbzPZUEvJ6YyU6c+LXCpMvZxaQN6jBE6CCQ0gmHRTd+4Xmo1b7+iPf6IGHWtmrYAZlA2MBK0f2cYG1fWPFjWSLe9vPHOv6DK61g26euShd10nsFBeY1ocWlI6WnfkBT9Q3e/g+bY11ejMDsf0/9LY9gfpQPSed+FM1QW+bunwyZAWnFNjtdOC9YKkXzokvFfYpnM0XRt0kfzQaTRptdw4gq6ewAv7TlcbYSvrmRowewG9QtffDZ0/OllD6ovVDtcwbi8P1y601CgsNtWB1OWurcchARGaYGg4ZGBXomELkmxBhjSkEwipbEEifJcBfdztAMLR2xfQpdMF3fjHSSofPpbAFsBSqvKGwfFd4FudQi31tCUTMoNJE3WqqFIJx+a7mPstqpX0ZXsIEQAKTnFapQcp/PHX4cOn/998ntyMh49fvlLspgvqFKt0kk268tXJRYIUVXdKUYh1S0eM5wTankd169JwwDJL+lmx5XbhoBaFY79sHIM35nF83K5YFErMZ33+sMJT/ZnOHcPvvTtT9GV+j6DKUCFUNlZSn8eKOcXganPpg9paNKSUDRbEFiQAqPiGRQGoAi4niGq/KFAhCm/kUa2uf8n41ZBmrdWC6ytlLzh+xbUtrM0YFjUHh6rDssEBmDptNqNGym7VDAuldCx4do25fHShMLevbnCopcPBx74uHGMa67bs7fKJGH7k+w4IomoEldwpHSqAVppZ2oZB9cV03YAbc8bCJGK1VnGkgH2GBLi1wlIuHUsgmNLtOEY+pllQ1gy6XunQgfkoc+zU0J2QB2WjofAMkofGdUgHuvt1BxKCdQJRkUoHEczEoyB6CrBea0rplg4HyDMsyQumKq6VzE+oFTal8wwKwDMstd8MGZahdeP7DHUGqVs636BA+eKjDZtMS7MXQyewPQmcqFee6exVIPXkGExL5y2UtKygCcG2CysP5pQN3zfuewTH0gkPBdzsb3A8DMde6WwIUlRuxvFsjoPkB38q49NBLGdB5sTUjFvi7lUxVP7BjrP1s7e0tUPimOFX3fnpP87+/sX+fq92/cvJa+S1yTa4MOlPdJ963w0uf0Vf2z3mXgXPuYlkQ1Z0uPsF7ti1zmbHf2IW3EFW2PRGIq97s8KmIhXwfeViNllbU7xn4n09SL8VddD33JeSS2hhQ3P0l/iXO7t08Mo6g7psMgaLzxjs9X1YggoWINUXzOHr7lEi6RmDF1pgCMorZJQSEtrs18Or/JC8QhDuorbrA1cnguH5rNF7KbBAvyIvndcaZVmamLWa6dqSmLPHhW4mjNZOpRRnlNScRgmlaCgxVonfwPES3BprVII1Qp1B3D6oOc2DclT++luyRvzmVGONsq2RetHWCHX7RZojtXhzNKNBuPtlQ5WVsE57IiU/lhIbKaGg3UyWVVIHZVolBO2+9AxvMXj/YnO9xJabf02H/C2y8N8rSUZsPoPyYPpeYH72KVYtVBaNYcs2bChhaoAeDrBlq3ychaTGtB1h2tLc5kuxbUqhodYRpg0dYtjOwfrFjGPhhk3OadhK5QBRsGUjiCFGETGJxOdZTtB5XKALJYtzSwryEuhLkxWoYOYYH2iiW9RCuvc03s9FkMxAn6SaksyoaWN3lPOTopkuxPnhEyDd4suGURSuepQEoYigHm2SKvOyoXYrzykqQMk+eyDeVUEas6K5L6axrV4tfkZzHV6NgKJSWEJFl1ck7VWodbn6kRpBA7S7EAwNz9C1X7BBprqz5aFRR3VdQ0A/C8FA8fRS200eYz99GCRu1hcgqIuFYISAwquNbt77vqSX8FcnRIBWFYIRARyDZaTZaKL3aL3QAVpOiEUH2htqQsYTXb1OTlSLChm7YDNZVtyz88h3pQiVT3XOakjKpzoL1pBgOYlJ5zysI6l8cX5WZ9LSMQLLQ7TpFBuMNMYtzf/LW1AhTVyztQSUfwjGCSz/YP5G5cpM90MB9bMQDAWfDskqcdwSnJphAfSjEItFjyd/vArsm0ndsAAaTAjGAqyG182pRX1T1ljeC1brhgvQakIwLjy5Q3Ghv3w9deqKCtQ7QjAq8MEYOAZJ/XgdqIuEYGDAqIUC891nrl1cahy0QM0kBEMEBi023sWV6RtAu5bZ9dJ4UHcJwaiBIUySDqjzyoK6RQjGCIxtYnRAjA+Ig/W+pvQA1B1CMG5Q6VMd6QGowYNgKMA+e3WkB3ql0wMqSA/oXr8UPKvGiVjHIFM6WaCCZAF14WJnOu7ZT63ZUiqdRVBBFoGGRXHE2Iqq7ba3WjqroED+21E1ke78NQWRpRZEhkfZNwWRnKA3tf7H6C/lsov9g7ShN1vrX8HWM2kik7vAzX/UJbUjyg3Jg/eDyH/x8ickJSoLvN/jv8lOzID3TSpNNaEMvV/MvdO5NJPK9/crt6a3uiKct6VfWiXUiSKsImWPBKv9IyW4l3ijftJbLFqAIQIjIdH0bfSVneZtRyRXs1fU0aAXz/orWwHFOUv9hPcid3jvpQ/ZsqJ88T5PPhQYFWU73GeKi47CRklgE5xVHsEG8jMKi5P6/A4Si1rZaQupGDWliCJCnk5cUhSZl5Sw5DkWg3QqH/MMoB76vtSCp5lGivorfEpI/+B2mqAAFaZrBnxCQduN95imqGCCRwYeUFWiUDz6TdPaAmCFahhBPb2nYvy0ZQYS1Emr3lpp7OsN6TWd76ptImRghIDG1YLXHphfwHJA7ry96n2daKqNDeB4CLZTQLV2bY4CzkIHaLIrFh0UtAAUdW5EnC4N6aWDuKawndzBfcH2E0sRjurJICwWEtwfrO8z4JfeIjXIpi2EjDxcPKrdXjC3UHgOZ1lC0ee3zibkM3H2bts35IcA8qOrHEl+hI5ddcmPfg5WuonaUhb7yeTIvrMDTnM6wQy9egQE+6G5AI9TFuxxSo3Hmb5Q8m52lutxDoATzDRncU2NMNlgq/ExyvYx+v1sH0OBTkTcu1FaDR9jADTZmq4tNuH3NekoODh4MwUUluJIKqDrlg/R99TOgrWCCNhfEQsR6vA+nbfh5W9UUkOqbfndyiRoFd6yzIAQ2EsRDSHABVd5zzIDEKj/o2C912xaFoEr0EUSxLWw+Bd1JADYUZrPHN++vJLGrhOb6pxUbZcmC06gb7loxQm29ajNNlqW+yiVDdCgvhvQWdh0y8YGIX636mIIp8KII3hzLIvHuiqYbkJBHX3xfFNKHccgmc+tduPvUXAafDgDEVXxzW4orNIpLEnuZlNY8gCilKTKU1iowxu49pqK7Q2TumfXsAy/xa6rZeX8ZXsIgwXKSoEuIsQyahSQGf2tVEKrGF9noQKQVqJRgYhFisokbCxeK0AACko0IFCTt4bxOBVYiMoCkS2O8kA8P0xjsKRv1cqwWuNQZ/oKcxxdrlULrDNhBVpDiF6wqf39Kh9aZ6IDEFOC0UE5TkThsykjeMTnCj4HOCtqhY4czqpij8XKETZgF/h/2I0WX3J+ahpGRAKgbJ5g7NTouZeIWSSUiJ5z91PoJRIGUE9wHI54R+DGpBe6S6leE2upOR9ep3h19uOLm4g8Z1JJJxGRI0jhgfKebM5RwYgcNVt3R9lUdJ663uL82OB4yxS6GjZQxZRfhH1hzlmAkU55H1mNUbRxpmonp3WWU3JvDzO7biJL5AZ/aaRa5SSljYI+GGnGN/mA6gvzTmy9r3BmhcVTIb7BfXS3LxuLewkWN9kvq7G4oQBLEMHQWNxsi5sSs1yOxQVi1jdlcf0d50oZXUnOa3TPslN8qNFNJrwjBe03uskH1L4kwOhKfOJQPJfrM3G+MxvcGN7LMrxyvzG8oRBDZyc1hjfT8EopDSovxvAqg72G9+yZWYXHtm+uuQCS8jLPaV6cqJYTHaGicshWQlgyKh3UEfcNumS5ZUU6tbvzacIi8dz+HdWsjWtTgmvTQ3FPAzqMrK5+TUPhH+fXXDqFL/HZkvuTIxtFJCLGSvTBUaG6HrAXRvUPPkEyT262WfbMzZcrefjo/bE75JQT4DeeaJPmr+ypTxfbNEUGKmfZnD9ia+li4oEUXtYWKqhOXSxUUnOGUBHAQtXrYq26LAHAjmKGvbXBxpR+3qO7xiraDjgLqdCWlKguwXrZFUXDuTGf3Z1mdjC0U2uYgNxe0TBBxO7IxgZ1pr6seIiupDFxh23wYILgpmiLj3fVLHzJwja3a1sctlChhY9tmLDdWhnalmI2TibdR8Z3uffpB4PXDF6w4F0wvDx30Z7jCLLmevkUtHVpoNtfDy8YOrBZgWsc3Uwsr50EiyjYv3UzixKw8SoaICiCGP271p16eywycNCEaGgE71gKOJnxLWw95d55kmABErTvpPCp22/roNm3IAtBc61MWeiUKws86yNqw7qTUzaqJhlyXi2Rsn8kKpWBb4D9hlJc3lzaQnBQXrbtOPU83xPFortXYQjNQpaOkZzjm6RfqOSEbfeyRSelULvYHOTuIL7B2OvJUTHMvD84HLfYFOQuf3J5WXJ9jDqsYm59J/eRQqfK9YkqUWy0dYwPlUj6q5wOlPLWPioFpfzRS4sQJ6qULG21uCMzzO74Dw== \ No newline at end of file diff --git a/src/main/java/ch/zhaw/pm2/racetrack/Game.java b/src/main/java/ch/zhaw/pm2/racetrack/Game.java index 265cd15..11e03d1 100644 --- a/src/main/java/ch/zhaw/pm2/racetrack/Game.java +++ b/src/main/java/ch/zhaw/pm2/racetrack/Game.java @@ -26,8 +26,11 @@ public class Game implements GameSpecification { this.userInterface = userInterface; } - - public boolean initPhase() throws InvalidTrackFormatException { + /** + * This method will initialize the game. Therefore it interacts with the user via UserInterface + * @return true if the initialization is completed. Returns false if there is an error. + */ + public boolean initPhase() { File folder = new File("tracks"); File[] listOfFiles = folder.listFiles(); if (listOfFiles.length > 0) { @@ -35,8 +38,17 @@ public class Game implements GameSpecification { for (File file : listOfFiles) { tracks.add(file.getName()); } + File selectedTrack = listOfFiles[userInterface.selectOption("Select Track file", tracks)]; - selectTrack(selectedTrack); + try { + selectTrack(selectedTrack); + } catch (FileNotFoundException e) { + userInterface.printInformation("There is an unexpected Error with the trackfile Path. Add trackfiles only to tracks path. Exit the Game and Fix the Problem"); + return false; + } catch (InvalidTrackFormatException e) { + userInterface.printInformation("There is an unexpected Error with the trackfile. Format does not match specifications! Exit the Game and Fix the Problem"); + return false; + } List moveStrategies = new ArrayList<>(); moveStrategies.add("Do not move Strategy"); moveStrategies.add("User Move Strategy"); @@ -63,7 +75,6 @@ public class Game implements GameSpecification { } catch (FileNotFoundException e) { userInterface.printInformation("There is no Move-List implemented. Choose another Strategy!"); } - //TODO: Backslash kompatibel für Linux break; case 4: filePath = ".\\follower\\" + selectedTrack.getName().split("\\.")[0] + "_points.txt"; @@ -86,17 +97,11 @@ public class Game implements GameSpecification { /** * The functionality was taken out of init to automate testing - * * @param selectedTrack */ - Track selectTrack(File selectedTrack) { - try { - track = new Track(selectedTrack); - return track; - } catch (FileNotFoundException | PositionVectorNotValid | InvalidTrackFormatException e) { - e.printStackTrace(); - } - return null; + Track selectTrack(File selectedTrack) throws InvalidTrackFormatException,FileNotFoundException { + track = new Track(selectedTrack); + return track; } /** @@ -198,9 +203,8 @@ public class Game implements GameSpecification { * for this turn */ @Override - public void doCarTurn(Direction acceleration) throws PositionVectorNotValid { + public void doCarTurn(Direction acceleration) throws PositionVectorNotValidException { track.getCar(currentCarIndex).accelerate(acceleration); - PositionVector crashPosition = null; List positionList = calculatePath(track.getCarPos(currentCarIndex), track.getCar(currentCarIndex).nextPosition()); for (int i = 0; i < positionList.size(); i++) { @@ -221,7 +225,12 @@ public class Game implements GameSpecification { } } - public String gamePhase() throws PositionVectorNotValid { + /** + * This method implements the gameflow in a while loop. If there is a winner. The method will return its carid. + * + * @return the ID of the winning car return null if there is no winner. + */ + public String gamePhase() { while (carsMoving() && getWinner() == NO_WINNER) { userInterface.printTrack(track); Direction direction; @@ -230,7 +239,12 @@ public class Game implements GameSpecification { track.getCar(currentCarIndex).setMoveStrategy(new DoNotMoveStrategy()); direction = track.getCar(currentCarIndex).getMoveStrategy().nextMove(); } - doCarTurn(direction); + try { + doCarTurn(direction); + } catch (PositionVectorNotValidException e) { + e.printStackTrace(); + userInterface.printInformation("There has been an unexpected Error. It seems that the trackfile is not Valid. Please do only use the given trackfiles. Otherwise please check that your selfmade tracks have borders arround the track."); + } switchToNextActiveCar(); } userInterface.printTrack(track); @@ -275,42 +289,46 @@ public class Game implements GameSpecification { } - + /** + * This method will check if a car is passing the finishline. + * If the car is passing the finishline in the wrong direction, the car will lose a winpoint. + * If the car is passing the finishline in the correct direction, the car will gain a winpoint. + * @param start the startposition of the car + * @param finish the expected finishpositon of the car after the move + * @param carIndex of the current player. + */ private void calculateWinner(PositionVector start, PositionVector finish, int carIndex) { List path = calculatePath(start, finish); for (PositionVector point : path) { - if (track.getSpaceType(point) != null) { - switch (track.getSpaceType(point)) { - case FINISH_UP: - if (start.getY() < finish.getY()) { - track.getCar(carIndex).increaseWinPoints(); - } else if (start.getY() > finish.getY()) { - track.getCar(carIndex).deductWinPoints(); - } - break; - case FINISH_DOWN: - if (start.getY() > finish.getY()) { - track.getCar(carIndex).increaseWinPoints(); - } else if (start.getY() < finish.getY()) { - track.getCar(carIndex).deductWinPoints(); - } - break; - case FINISH_RIGHT: - if (start.getX() < finish.getX()) { - track.getCar(carIndex).increaseWinPoints(); - } else if (start.getX() > finish.getX()) { - track.getCar(carIndex).deductWinPoints(); - } - break; - case FINISH_LEFT: - if (start.getX() > finish.getX()) { - track.getCar(carIndex).increaseWinPoints(); - } else if (start.getX() < finish.getX()) { - track.getCar(carIndex).increaseWinPoints(); - } - break; - } - + switch (track.getSpaceType(point)) { + case FINISH_UP: + if (start.getY() < finish.getY()) { + track.getCar(carIndex).increaseWinPoints(); + } else if (start.getY() > finish.getY()) { + track.getCar(carIndex).deductWinPoints(); + } + break; + case FINISH_DOWN: + if (start.getY() > finish.getY()) { + track.getCar(carIndex).increaseWinPoints(); + } else if (start.getY() < finish.getY()) { + track.getCar(carIndex).deductWinPoints(); + } + break; + case FINISH_RIGHT: + if (start.getX() < finish.getX()) { + track.getCar(carIndex).increaseWinPoints(); + } else if (start.getX() > finish.getX()) { + track.getCar(carIndex).deductWinPoints(); + } + break; + case FINISH_LEFT: + if (start.getX() > finish.getX()) { + track.getCar(carIndex).increaseWinPoints(); + } else if (start.getX() < finish.getX()) { + track.getCar(carIndex).increaseWinPoints(); + } + break; } } } @@ -324,7 +342,7 @@ public class Game implements GameSpecification { * @return A boolean indicator if the car would crash with a WALL or another car. */ @Override - public boolean willCarCrash(int carIndex, PositionVector position) throws PositionVectorNotValid { + public boolean willCarCrash(int carIndex, PositionVector position) throws PositionVectorNotValidException { return track.willCrashAtPosition(carIndex, position); } diff --git a/src/main/java/ch/zhaw/pm2/racetrack/InvalidFileFormatException.java b/src/main/java/ch/zhaw/pm2/racetrack/InvalidFileFormatException.java index 6655e69..f530593 100644 --- a/src/main/java/ch/zhaw/pm2/racetrack/InvalidFileFormatException.java +++ b/src/main/java/ch/zhaw/pm2/racetrack/InvalidFileFormatException.java @@ -4,6 +4,7 @@ package ch.zhaw.pm2.racetrack; * Class for Exception when invalid Fileformat is used. */ public class InvalidFileFormatException extends Exception { + public InvalidFileFormatException(){super();} public InvalidFileFormatException(String errorMessage) { super(errorMessage); } diff --git a/src/main/java/ch/zhaw/pm2/racetrack/Main.java b/src/main/java/ch/zhaw/pm2/racetrack/Main.java index aec65bd..625dc53 100644 --- a/src/main/java/ch/zhaw/pm2/racetrack/Main.java +++ b/src/main/java/ch/zhaw/pm2/racetrack/Main.java @@ -1,12 +1,11 @@ package ch.zhaw.pm2.racetrack; -import java.io.FileNotFoundException; import java.util.ArrayList; import java.util.List; public class Main { - public static void main(String[] args) throws InvalidTrackFormatException, PositionVectorNotValid { + public static void main(String[] args) { UserInterface userInterface = new UserInterface("Hello and Welcome to Racetrack by Team02-\"AngryNerds\""); while (true) { Game game = new Game(userInterface); diff --git a/src/main/java/ch/zhaw/pm2/racetrack/PositionVectorNotValid.java b/src/main/java/ch/zhaw/pm2/racetrack/PositionVectorNotValid.java deleted file mode 100644 index 2b70333..0000000 --- a/src/main/java/ch/zhaw/pm2/racetrack/PositionVectorNotValid.java +++ /dev/null @@ -1,9 +0,0 @@ -package ch.zhaw.pm2.racetrack; - -public class PositionVectorNotValid extends Throwable { - public PositionVectorNotValid(String message) { - super(message); - } - - public PositionVectorNotValid() {} -} diff --git a/src/main/java/ch/zhaw/pm2/racetrack/PositionVectorNotValidException.java b/src/main/java/ch/zhaw/pm2/racetrack/PositionVectorNotValidException.java new file mode 100644 index 0000000..e3d75b2 --- /dev/null +++ b/src/main/java/ch/zhaw/pm2/racetrack/PositionVectorNotValidException.java @@ -0,0 +1,9 @@ +package ch.zhaw.pm2.racetrack; + +public class PositionVectorNotValidException extends Throwable { + public PositionVectorNotValidException(String message) { + super(message); + } + + public PositionVectorNotValidException() {} +} diff --git a/src/main/java/ch/zhaw/pm2/racetrack/Track.java b/src/main/java/ch/zhaw/pm2/racetrack/Track.java index e0a6ff4..da1b495 100644 --- a/src/main/java/ch/zhaw/pm2/racetrack/Track.java +++ b/src/main/java/ch/zhaw/pm2/racetrack/Track.java @@ -69,7 +69,7 @@ public class Track implements TrackSpecification { * @throws FileNotFoundException if the given track file could not be found * @throws InvalidTrackFormatException if the track file contains invalid data (no tracklines, ...) */ - public Track(File trackFile) throws FileNotFoundException, InvalidTrackFormatException, PositionVectorNotValid { + public Track(File trackFile) throws FileNotFoundException, InvalidTrackFormatException { track = new ArrayList<>(); cars = new ArrayList<>(); finishLine = new ArrayList<>(); @@ -161,11 +161,11 @@ public class Track implements TrackSpecification { track.add(positionVector.getY(), line); } - private void isPositionVectorOnTrack(PositionVector positionVector) throws PositionVectorNotValid { + private void isPositionVectorOnTrack(PositionVector positionVector) throws PositionVectorNotValidException { try{ track.get(positionVector.getY()).charAt(positionVector.getX()); }catch (IndexOutOfBoundsException e) { - throw new PositionVectorNotValid(); + throw new PositionVectorNotValidException(); } } @@ -230,7 +230,7 @@ public class Track implements TrackSpecification { * @param positionVector the position to check if the car could crash * @return true if car would crash. Else false. */ - public boolean willCrashAtPosition(int carIndex, PositionVector positionVector) throws PositionVectorNotValid { + public boolean willCrashAtPosition(int carIndex, PositionVector positionVector) throws PositionVectorNotValidException { isPositionVectorOnTrack(positionVector); //TODO: remove this line? Or Method? char charAtPosition = track.get(positionVector.getY()).charAt(positionVector.getX()); if (getCarId(carIndex) == charAtPosition) return false; @@ -247,7 +247,7 @@ public class Track implements TrackSpecification { * @param carIndex representing current Car * @param crashPositionVector where the Crash did happen */ - public void carDoesCrash(int carIndex, PositionVector crashPositionVector) throws PositionVectorNotValid{ + public void carDoesCrash(int carIndex, PositionVector crashPositionVector) throws PositionVectorNotValidException { isPositionVectorOnTrack(crashPositionVector); //TODO: remove this line? and Method? PositionVector currentCarPosition = getCarPos(carIndex); drawCharOnTrackIndicator(new PositionVector(currentCarPosition.getX(), currentCarPosition.getY()), ConfigSpecification.SpaceType.TRACK.getValue()); @@ -266,7 +266,6 @@ public class Track implements TrackSpecification { */ @Override public Config.SpaceType getSpaceType(PositionVector position) { - //isPositionVectorOnTrack(position); Should be used but we are not allowed to change method head. We don't use function anyway char charAtPosition = track.get(position.getY()).charAt(position.getX()); ConfigSpecification.SpaceType[] spaceTypes = ConfigSpecification.SpaceType.values(); for (ConfigSpecification.SpaceType spaceType : spaceTypes) { @@ -274,8 +273,7 @@ public class Track implements TrackSpecification { return spaceType; } } - - return null; + return ConfigSpecification.SpaceType.WALL; } /** diff --git a/src/main/java/ch/zhaw/pm2/racetrack/given/GameSpecification.java b/src/main/java/ch/zhaw/pm2/racetrack/given/GameSpecification.java index c9148e5..4810ad1 100644 --- a/src/main/java/ch/zhaw/pm2/racetrack/given/GameSpecification.java +++ b/src/main/java/ch/zhaw/pm2/racetrack/given/GameSpecification.java @@ -1,7 +1,7 @@ package ch.zhaw.pm2.racetrack.given; import ch.zhaw.pm2.racetrack.PositionVector; -import ch.zhaw.pm2.racetrack.PositionVectorNotValid; +import ch.zhaw.pm2.racetrack.PositionVectorNotValidException; import java.util.List; @@ -19,11 +19,11 @@ public interface GameSpecification { int getWinner(); - void doCarTurn(PositionVector.Direction acceleration) throws PositionVectorNotValid; + void doCarTurn(PositionVector.Direction acceleration) throws PositionVectorNotValidException; void switchToNextActiveCar(); List calculatePath(PositionVector startPosition, PositionVector endPosition); - boolean willCarCrash(int carIndex, PositionVector position) throws PositionVectorNotValid; + boolean willCarCrash(int carIndex, PositionVector position) throws PositionVectorNotValidException; } diff --git a/src/test/java/ch/zhaw/pm2/racetrack/GameTest.java b/src/test/java/ch/zhaw/pm2/racetrack/GameTest.java index 0c1dea3..f5a8005 100644 --- a/src/test/java/ch/zhaw/pm2/racetrack/GameTest.java +++ b/src/test/java/ch/zhaw/pm2/racetrack/GameTest.java @@ -7,6 +7,7 @@ import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Assertions; import java.io.File; +import java.io.FileNotFoundException; import java.util.List; import static ch.zhaw.pm2.racetrack.Game.NO_WINNER; import static ch.zhaw.pm2.racetrack.PositionVector.Direction.*; @@ -35,7 +36,12 @@ class GameTest { void setup() { userInterface = new UserInterface("Test"); game = new Game(userInterface); - track = game.selectTrack(new File(TRACK_FILE_PATH)); + try { + track = game.selectTrack(new File(TRACK_FILE_PATH)); + } catch (InvalidTrackFormatException | FileNotFoundException e) { + e.printStackTrace(); + Assertions.fail(); + } game.selectMoveStrategy(track.getCar(CAR_INDEX_ONE), new UserMoveStrategy(new UserInterface("Testing"), CAR_INDEX_ONE, track.getCarId(CAR_INDEX_ONE))); game.selectMoveStrategy(track.getCar(CAR_INDEX_TWO), new UserMoveStrategy(new UserInterface("Testing"), CAR_INDEX_TWO, track.getCarId(CAR_INDEX_TWO))); @@ -93,7 +99,12 @@ class GameTest { void setup() { userInterface = new UserInterface("Test"); game = new Game(userInterface); - track = game.selectTrack(new File(TRACK_FILE_PATH)); + try { + track = game.selectTrack(new File(TRACK_FILE_PATH)); + } catch (InvalidTrackFormatException | FileNotFoundException e) { + e.printStackTrace(); + Assertions.fail(); + } game.selectMoveStrategy(track.getCar(CAR_INDEX_ONE), new UserMoveStrategy(new UserInterface("Testing"), CAR_INDEX_ONE, track.getCarId(CAR_INDEX_ONE))); game.selectMoveStrategy(track.getCar(CAR_INDEX_TWO), new UserMoveStrategy(new UserInterface("Testing"), CAR_INDEX_TWO, track.getCarId(CAR_INDEX_TWO))); @@ -104,8 +115,8 @@ class GameTest { try { game.doCarTurn(RIGHT); Assertions.assertEquals(new PositionVector(1, 0), game.getCarVelocity(0)); - } catch (PositionVectorNotValid positionVectorNotValid) { - positionVectorNotValid.printStackTrace(); + } catch (PositionVectorNotValidException positionVectorNotValidException) { + positionVectorNotValidException.printStackTrace(); } } @@ -114,8 +125,8 @@ class GameTest { try { game.doCarTurn(PositionVector.Direction.UP); Assertions.assertTrue(game.onlyOneCarLeft()); - } catch (PositionVectorNotValid positionVectorNotValid) { - positionVectorNotValid.printStackTrace(); + } catch (PositionVectorNotValidException positionVectorNotValidException) { + positionVectorNotValidException.printStackTrace(); } } } @@ -169,23 +180,15 @@ class GameTest { UP_RIGHT, RIGHT, RIGHT})); - try { - game.initPhase(); - Assertions.assertEquals("a",game.gamePhase()); - } catch (InvalidTrackFormatException | PositionVectorNotValid e) { - e.printStackTrace(); - } + game.initPhase(); + Assertions.assertEquals("a",game.gamePhase()); } @Test void crashA() { game = new Game(new interFace("Test",new Integer[]{0,2,2},new PositionVector.Direction[]{UP})); - try { - game.initPhase(); - Assertions.assertEquals("b",game.gamePhase()); - } catch (InvalidTrackFormatException | PositionVectorNotValid e) { - e.printStackTrace(); - } + game.initPhase(); + Assertions.assertEquals("b",game.gamePhase()); } } diff --git a/src/test/java/ch/zhaw/pm2/racetrack/TrackTest.java b/src/test/java/ch/zhaw/pm2/racetrack/TrackTest.java index d5cff22..a19e607 100644 --- a/src/test/java/ch/zhaw/pm2/racetrack/TrackTest.java +++ b/src/test/java/ch/zhaw/pm2/racetrack/TrackTest.java @@ -21,10 +21,11 @@ public class TrackTest { File file = new File(".\\tracks\\challenge.txt"); try { trackObj = new Track(file); - - } catch (Exception | PositionVectorNotValid e) { - System.err.println("Error in Test compareTrack" + e.getMessage()); + } catch (FileNotFoundException | InvalidTrackFormatException e) { + e.printStackTrace(); + Assertions.fail(); } + } @Test @@ -79,7 +80,7 @@ public class TrackTest { track.add("##################################################"); track.add("##################################################"); Assertions.assertLinesMatch(track, trackObj.getTrack()); - } catch (FileNotFoundException | InvalidTrackFormatException | PositionVectorNotValid e) { + } catch (FileNotFoundException | InvalidTrackFormatException e) { e.printStackTrace(); } } @@ -115,8 +116,8 @@ public class TrackTest { Assertions.assertFalse(trackObj.willCrashAtPosition(0, new PositionVector(7, 22))); //Car will not Crash and is on finishLine Assertions.assertFalse(trackObj.willCrashAtPosition(0, trackObj.getFinishLine().get(0))); - } catch (PositionVectorNotValid positionVectorNotValid) { - positionVectorNotValid.printStackTrace(); + } catch (PositionVectorNotValidException positionVectorNotValidException) { + positionVectorNotValidException.printStackTrace(); Assertions.fail("Test should not throw error"); } } @@ -126,8 +127,8 @@ public class TrackTest { void makeCarCrash() { try { trackObj.carDoesCrash(0, new PositionVector(6, 22)); - } catch (PositionVectorNotValid positionVectorNotValid) { - positionVectorNotValid.printStackTrace(); + } catch (PositionVectorNotValidException positionVectorNotValidException) { + positionVectorNotValidException.printStackTrace(); Assertions.fail("Test should not throw exception"); } Assertions.assertEquals(Track.CRASH_INDICATOR, trackObj.getTrack().get(22).charAt(6)); @@ -146,7 +147,7 @@ public class TrackTest { try { trackObj = new Track(file); - } catch (Exception | PositionVectorNotValid e) { + } catch (InvalidTrackFormatException | FileNotFoundException e) { System.err.println("Error in Test compareTrack" + e.getMessage()); } } @@ -168,8 +169,8 @@ public class TrackTest { @Test @DisplayName("Invalid Position Vector used") void invalidPositionVector() { - Assertions.assertThrows(PositionVectorNotValid.class, () -> trackObj.willCrashAtPosition(0, new PositionVector(100, 200))); - Assertions.assertThrows(PositionVectorNotValid.class, () -> trackObj.carDoesCrash(1,new PositionVector(200,100))); + Assertions.assertThrows(PositionVectorNotValidException.class, () -> trackObj.willCrashAtPosition(0, new PositionVector(100, 200))); + Assertions.assertThrows(PositionVectorNotValidException.class, () -> trackObj.carDoesCrash(1,new PositionVector(200,100))); } } From eca2e2eb9bc155307a96dc5fe3a2a2ef94763685 Mon Sep 17 00:00:00 2001 From: Andrin Fassbind Date: Thu, 24 Mar 2022 17:02:42 +0100 Subject: [PATCH 5/5] refactored merge conflict in Track --- .../java/ch/zhaw/pm2/racetrack/Track.java | 40 ++++++++----------- 1 file changed, 16 insertions(+), 24 deletions(-) diff --git a/src/main/java/ch/zhaw/pm2/racetrack/Track.java b/src/main/java/ch/zhaw/pm2/racetrack/Track.java index d2d8036..02ddd9a 100644 --- a/src/main/java/ch/zhaw/pm2/racetrack/Track.java +++ b/src/main/java/ch/zhaw/pm2/racetrack/Track.java @@ -124,8 +124,8 @@ public class Track implements TrackSpecification { } //TODO: THIS + /** - * * @throws InvalidTrackFormatException */ private void findFinish() throws InvalidTrackFormatException { @@ -174,7 +174,7 @@ public class Track implements TrackSpecification { * Method that places a character at a chosen position * * @param positionVector position where char will be placed - * @param symbol char that should be placed at desired position + * @param symbol char that should be placed at desired position */ private void drawCharOnTrackIndicator(PositionVector positionVector, char symbol) { String line = track.get(positionVector.getY()); @@ -183,19 +183,17 @@ public class Track implements TrackSpecification { track.add(positionVector.getY(), line); } //TODO: check if this method is okay and needed + /** * Determines if a location is valid PositionVector inside the track * * @param positionVector of location that has to be checked - * @throws PositionVectorNotValid if the PositionVector does not lie on the track. + * @throws PositionVectorNotValidException if the PositionVector does not lie on the track. */ - private void isPositionVectorOnTrack(PositionVector positionVector) throws PositionVectorNotValid { - try { - private void isPositionVectorOnTrack(PositionVector positionVector) throws PositionVectorNotValidException { - try{ + try { track.get(positionVector.getY()).charAt(positionVector.getX()); - }catch (IndexOutOfBoundsException e) { + } catch (IndexOutOfBoundsException e) { throw new PositionVectorNotValidException(); } } @@ -256,8 +254,8 @@ public class Track implements TrackSpecification { /** * This Method will check if the Car would crash at the specific position * - * @param positionVector the position to check if the car would crash - * @return true if crash otherwise false + * @param positionVector the position to check if the car could crash + * @return true if car would crash. Else false. */ public boolean willCrashAtPosition(int carIndex, PositionVector positionVector) throws PositionVectorNotValidException { isPositionVectorOnTrack(positionVector); //TODO: remove this line? Or Method? @@ -271,10 +269,10 @@ public class Track implements TrackSpecification { } /** - * This Method will mark the Car as crashed inside the track and the car Object. + * This Method will make the Car Crash. In Track and in the Car Object * - * @param carIndex of car that will be marked as crashed - * @param crashPositionVector of the location of the crash + * @param carIndex representing current Car + * @param crashPositionVector where the Crash did happen */ public void carDoesCrash(int carIndex, PositionVector crashPositionVector) throws PositionVectorNotValidException { isPositionVectorOnTrack(crashPositionVector); //TODO: remove this line? and Method? @@ -291,7 +289,7 @@ public class Track implements TrackSpecification { * If the location is outside the track bounds, it is considered a wall. * * @param position The coordinates of the position to examine - * @return The type of space at the desired position + * @return The type of track position at the given location */ @Override public Config.SpaceType getSpaceType(PositionVector position) { @@ -303,13 +301,14 @@ public class Track implements TrackSpecification { return spaceType; } } - return ConfigSpecification.SpaceType.WALL; + + return null; } /** - * Return the number of cars that are located in a track + * Return the number of cars. * - * @return number of cars as int + * @return Number of cars */ @Override public int getCarCount() { @@ -383,13 +382,6 @@ public class Track implements TrackSpecification { return currentSpace.getValue(); } - /** - * Determines all points that lie between the two position vectors including the endpoint VectorPosition using the Bresenham algorithm. - * - * @param startPosition PositionVector of the finish coordinate - * @param endPosition PositionVector of the start coordinate - * @return ArrayList containing PositionVectors of all position that are between the start and finish including the finish position. - */ public ArrayList calculatePointsOnPath(PositionVector startPosition, PositionVector endPosition) { ArrayList pathList = new ArrayList<>(); // Use Bresenham's algorithm to determine positions.