diff --git a/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/Main.java b/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/Main.java index dd5a61d..0ef6962 100644 --- a/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/Main.java +++ b/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/Main.java @@ -3,8 +3,8 @@ import edu.ntnu.idi.idatt2003.g40.mappe.engine.Exchange; import edu.ntnu.idi.idatt2003.g40.mappe.model.Player; import edu.ntnu.idi.idatt2003.g40.mappe.model.Stock; -import edu.ntnu.idi.idatt2003.g40.mappe.service.FileParser; -import edu.ntnu.idi.idatt2003.g40.mappe.service.FileManager; +import edu.ntnu.idi.idatt2003.g40.mappe.service.StockFileParser; +import edu.ntnu.idi.idatt2003.g40.mappe.service.StockFileManager; import edu.ntnu.idi.idatt2003.g40.mappe.service.SaveGameService; import edu.ntnu.idi.idatt2003.g40.mappe.service.event.EventManager; import edu.ntnu.idi.idatt2003.g40.mappe.utils.ConfigValues; @@ -86,9 +86,9 @@ public void start(final Stage stage) throws Exception { ViewManager viewManager = new ViewManager(stage, eventManager); List stocksInFile; - FileManager parser1 = new FileManager("/sp500.csv"); + StockFileManager parser1 = new StockFileManager("/sp500.csv"); - FileParser converter1 = new FileParser(); + StockFileParser converter1 = new StockFileParser(); stocksInFile = converter1.getStocksFromStrings(parser1.readFile()); Exchange exchange = new Exchange("Exchange", stocksInFile); diff --git a/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/SaveGameService.java b/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/SaveGameService.java index 2c6aaed..0350071 100644 --- a/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/SaveGameService.java +++ b/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/SaveGameService.java @@ -1,7 +1,6 @@ package edu.ntnu.idi.idatt2003.g40.mappe.service; import edu.ntnu.idi.idatt2003.g40.mappe.model.SaveGame; - import java.io.IOException; import java.math.BigDecimal; import java.nio.charset.StandardCharsets; diff --git a/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/FileManager.java b/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/StockFileManager.java similarity index 97% rename from src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/FileManager.java rename to src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/StockFileManager.java index cd674cd..b1a782d 100644 --- a/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/FileManager.java +++ b/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/StockFileManager.java @@ -22,13 +22,13 @@ * to file, each stock separated by a line. * * - *

Used with {@link FileParser}

+ *

Used with {@link StockFileParser}

* - * @see FileParser + * @see StockFileParser * @author tohja * @version 1.0.0 * */ -public class FileManager { +public class StockFileManager { /** The path name this parser is using.*/ private final String pathName; @@ -102,7 +102,7 @@ private enum ParserRuleSet { * * @param pathName the file path name to read. * */ - public FileManager(final String pathName) { + public StockFileManager(final String pathName) { this.pathName = pathName; } diff --git a/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/FileParser.java b/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/StockFileParser.java similarity index 96% rename from src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/FileParser.java rename to src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/StockFileParser.java index c621a47..b08558d 100644 --- a/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/FileParser.java +++ b/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/StockFileParser.java @@ -17,13 +17,13 @@ * list of string elements. * * - *

Used with {@link FileManager}

+ *

Used with {@link StockFileManager}

* - * @see FileManager + * @see StockFileManager * @author tohja * @version 1.0.0 * */ -public class FileParser { +public class StockFileParser { /** * Turns a list of valid string representations diff --git a/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/TransactionFactory.java b/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/TransactionFactory.java index 490a93c..62e849c 100644 --- a/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/TransactionFactory.java +++ b/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/TransactionFactory.java @@ -23,7 +23,6 @@ private TransactionFactory() { * @param transactionType the type of transaction to create. * @param share the share this transaction is about. * @param week the week this transaction takes place in. - * @param calculator the calculator to use when calculating the transaction. * * @return an implementation of {@link Transaction}. * */ diff --git a/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/package-info.java b/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/package-info.java index 9a013e4..10593f1 100644 --- a/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/package-info.java +++ b/src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/package-info.java @@ -1,5 +1,5 @@ /** * Contains classes providing modular functionality to the application, - * such as the {@link edu.ntnu.idi.idatt2003.g40.mappe.service.FileParser}. + * such as the {@link edu.ntnu.idi.idatt2003.g40.mappe.service.StockFileParser}. * */ package edu.ntnu.idi.idatt2003.g40.mappe.service; diff --git a/src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/FileManagerTest.java b/src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/StockFileManagerTest.java similarity index 89% rename from src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/FileManagerTest.java rename to src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/StockFileManagerTest.java index 49dbd7e..9706b5c 100644 --- a/src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/FileManagerTest.java +++ b/src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/StockFileManagerTest.java @@ -11,12 +11,12 @@ import static org.junit.jupiter.api.Assertions.*; -class FileManagerTest { +class StockFileManagerTest { private final String testStockDataPath = "/testStockData.txt"; private final String absoluteTestStockDataPath = "src/main/resources/testStockData.txt"; - FileManager fileManager; + StockFileManager stockFileManager; private final String validStockFromFile = "NVID, Nvidida Corporation, 241.591"; @@ -30,11 +30,11 @@ class FileManagerTest { @BeforeEach void setUp() throws Exception { - fileManager = new FileManager(testStockDataPath); + stockFileManager = new StockFileManager(testStockDataPath); Path path = Paths.get(absoluteTestStockDataPath); allLines = Files.readAllLines(path); try { - validStocks = fileManager.readFile(); + validStocks = stockFileManager.readFile(); } catch (Exception _) { throw new Exception("Test failed"); } diff --git a/src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/FileParserTest.java b/src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/StockFileParserTest.java similarity index 94% rename from src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/FileParserTest.java rename to src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/StockFileParserTest.java index fb59fc6..61ecfb2 100644 --- a/src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/FileParserTest.java +++ b/src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/StockFileParserTest.java @@ -8,9 +8,9 @@ import java.util.ArrayList; import java.util.List; -class FileParserTest { +class StockFileParserTest { - private FileParser converter; + private StockFileParser converter; private String validStockAsString1; private String validStockAsString2; @@ -33,7 +33,7 @@ void setUp() { allStocks.add(validStockAsString3); allStocks.add(invalidStockAsString1); - converter = new FileParser(); + converter = new StockFileParser(); } @Test diff --git a/src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/event/EventManagerTest.java b/src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/event/EventManagerTest.java index 4852d1c..eee20c2 100644 --- a/src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/event/EventManagerTest.java +++ b/src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/event/EventManagerTest.java @@ -6,6 +6,7 @@ import static org.junit.jupiter.api.Assertions.assertNull; import static org.junit.jupiter.api.Assertions.assertThrows; import static org.junit.jupiter.api.Assertions.assertTrue; + import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -28,8 +29,19 @@ private enum TestEventTypes implements EventChannel { } + /** + * Event manager used for testing. + * */ private EventManager testEventManager; + + /** + * Example event subscriber 1. + * */ private SampleEventSubscriber sampleEventSubscriber1; + + /** + * Example event subscriber 2. + * */ private SampleEventSubscriber sampleEventSubscriber2; @BeforeEach