Added MOD/EFF/REQ

src/main/data/DataSource.java

@@ -66,5 +66,6 @@ public abstract class DataSource {
         return Objects.hash(name);
     }
 
+    //Effect: returns updated data in the form: double[2], [0] is price, [1] is %change
     public abstract double[] update(String stype, String idstring) throws IOException;
 }

src/main/data/ListOfWatchList.java

@@ -15,16 +15,21 @@ public class ListOfWatchList {
         return lowl;
     }
 
+    //Effect: add a watchlist to this list, if it isn't already in the list
+    //Modifies: this
     public void addWatchList(WatchList wlist) {
         if (!(wlists.contains(wlist))) {
             wlists.add(wlist);
         }
     }
 
+    //Effect: remove a watchlist
+    //Modifies: this
     public void delWatchList(WatchList wlist) {
         wlists.remove(wlist);
     }
 
+    //Effect: return a watchlist by index
     public WatchList getWatchList(int index) {
         return (WatchList) wlists.get(index);
     }

src/main/data/Nyse.java

@@ -8,7 +8,6 @@ public class Nyse extends StockType {
     public Nyse() {
         super();
         name = "NYSE";
-	addSource(new AlphaVantage());
+        addSource(new AlphaVantage());
-	delSource(new AlphaVantage());
     }
 }

src/main/data/StockEntry.java

@@ -15,6 +15,9 @@ public class StockEntry {
         this.stype = stype;
     }
 
+    //Effect: return true if price or change is/are new
+    // update the price and %change by the stype update
+    //Modifies: this
     public boolean update() {
         boolean changed = false;
         updating = true;

src/main/data/StypeMap.java

@@ -31,6 +31,7 @@ public class StypeMap {
 
     // Effects: Returns the StockType
     // Require: Valid typeString
+    // note: this is a shortcut to getMap and then getInstStype
     public static StockType getStype(String typeString) {
         return stypemap.getInstStype(typeString);
     }

src/main/data/WatchList.java

@@ -44,12 +44,13 @@ public class WatchList extends Observable implements Load,Save {
         if (!listdata.containsKey(target)) {
             throw new StockNotExistsException();
         }
-	int index = new ArrayList(listdata.keySet()).indexOf(target);
+        int index = new ArrayList(listdata.keySet()).indexOf(target);
         this.listdata.remove(target);
         setChanged();
         notifyObservers(new Wevent(Etype.DEL, index));
     }
 
+    // Effects: return an array of all Stock names in list
     public String[] getNames() {
         return listdata.keySet().toArray(new String[0]);
     }
@@ -61,6 +62,7 @@ public class WatchList extends Observable implements Load,Save {
         return entryset.iterator();
     }
 
+    //Effects: return a stockentry given its index
     public StockEntry getStock(int index) {
         String key = (String) listdata.keySet().toArray()[index];
         return (StockEntry) listdata.get(key);
@@ -71,6 +73,7 @@ public class WatchList extends Observable implements Load,Save {
         return listdata.size();
     }
 
+    //Effect: save list to a file, save to DEFAULT_SAVEFILE if filename is empty
     @Override
     public void save(String filename) {
         if (filename.equals("")) {
@@ -93,12 +96,15 @@ public class WatchList extends Observable implements Load,Save {
         }
     }
 
+    //Effect: return true if filename exists and is a file
     @Override
     public boolean fileExists(String filename) {
         File fileObj = new File(filename);
         return fileObj.isFile();
     }
 
+    //Effect: load list from file, load from DEFAULT_SAVEFILE if filename is empty
+    //Modifies: this
     @Override
     public void load(String filename) {
         if (filename.equals("")) {
@@ -120,6 +126,8 @@ public class WatchList extends Observable implements Load,Save {
         }
     }
 
+    //Effect: perform price and %update for @ stockentry in list
+    //Modifies: this, stockentries
     public void updateList() {
         Iterator watchit = iterator();
         boolean changed = false;

src/main/network/AlphaVantage.java

@@ -12,6 +12,7 @@ public class AlphaVantage extends DataSource {
         super("AlphaVantage", "https://www.alphavantage.co/query", "4MC2LL0HOQ2TFQL1");
     }
 
+    //Effect: get intraday price and %change through JSON given the stock ticker
     @Override
     public double[] update(String stype, String idstring) throws IOException {
         double[] result = {0.0, 0.0};

src/main/network/Net.java

@@ -10,6 +10,7 @@ import network.exceptions.*;
 
 //Ref: https://stackoverflow.com/questions/2793150/how-to-use-java-net-urlconnection-to-fire-and-handle-http-requests
 public class Net {
+    //Effect: returns a String of url built with given url and paras
     public static String urlStringBuilder(String url, String... paras) throws ParaMismatchException {
         String urlString = url;
         String charset = "UTF-8";
@@ -31,6 +32,7 @@ public class Net {
         return urlString;
     }
 
+    //Effect: Open connection, fires a http GET and returns the InputStream of result
     public static InputStream urlToInputStream(String url) throws IOException {
         try {
             return (new URL(url).openStream());

src/main/network/StockJson.java

@@ -27,27 +27,31 @@ public class StockJson {
         }
     }
 
+    // Effect: return double from jsonnumber
     public static double doubleGetter(JsonObject jobj, String name) {
         return jobj.getJsonNumber(name).doubleValue();
     }
 
+    // Effect: return jsonobject from jsonobject
     public static JsonObject jsonInJson(JsonObject jobj, String name) {
         return jobj.getJsonObject(name);
     }
 
+    // Effect: return string from jsonstring
     public static String stringGetter(JsonObject jobj, String name) {
         return jobj.getString(name);
     }
 
+    // Effect: return double from percentage string
     public static double doublePercent(JsonObject jobj, String name) {
         String temp = stringGetter(jobj, name);
         return Double.parseDouble(temp.split("%")[0]);
     }
 
     // From https://stackoverflow.com/questions/33531041/jsonobject-get-value-of-first-node-regardless-of-name
+    // Effect: extract the jsonobject from jsonobject by index
     public static JsonObject timeSeriesElement(JsonObject jobj, int index) {
         String name = (String) jobj.keySet().toArray()[index];
-	System.out.println(name);
         return jsonInJson(jobj, name);
     }
 }

src/main/ui/Gui.java

@@ -21,6 +21,8 @@ public class Gui extends JFrame implements Iface {
     private WatchTablePane wtable;
     private WatchList wlist;
     private Runnable init = new Runnable() {
+        //Effect: Init gui all components 
+        //Modifies: this
         public void run() {
             addComponents();
             createLayout();
@@ -65,11 +67,15 @@ public class Gui extends JFrame implements Iface {
         setVisible(true);
     }
 
+    //Effect: nothing
+    //not enough time to do something useful for this
     @Override
     public void redraw() {
         //Nothing for now
     }
 
+    //Effect: nothing
+    //not enough time to do something useful for this
     @Override
     public void destory() {
         //Nothing for now

src/main/ui/Main.java

@@ -16,11 +16,6 @@ public class Main {
         iface = IfaceFactory.getIface();
     }
 
-    //Constructor for testing
-    public Main(boolean debug) {
-        WatchList mainList = new WatchList();
-    }
-
     // java main
     public static void main(String[] args) {
         new Main(args);

src/main/ui/Tui.java

@@ -29,6 +29,7 @@ public class Tui implements Iface, Observer {
         demo();
     }
 
+    //Effect: wait for user input and get a line (pressed Enter)
     public String getInputLine() {
         String result;
         try {
@@ -45,6 +46,8 @@ public class Tui implements Iface, Observer {
         return "";
     }
 
+    //Effect: capture user input, constantly
+    //Unused, for future dev uses
     public String readUntil(char end) {
         String result = "";
         char c;
@@ -88,18 +91,22 @@ public class Tui implements Iface, Observer {
         maxcol = maxCoord[1];
     }
 
+    //Effect: nothing has to be done
     @Override
     public void destory() {
         //Nothing has to be done
         return;
     }
 
+    //Effect: nothing
+    //will be used when Tui is redesigned
     @Override
     public void redraw() {
         //XXX Do nothing for now
         return;
     }
 
+    //Effect: Show a menu of functions
     public void demomenu() {
         System.out.println("Function select:");
         System.out.println("1: Update watchlist");
@@ -109,6 +116,7 @@ public class Tui implements Iface, Observer {
         System.out.println("Enter a number or q, then press enter.\n");
     }
 
+    //Effect: execute functions basing on user input from menu
     public boolean demoinput() {
         switch (getInputLine()) {
             case "1":
@@ -129,6 +137,7 @@ public class Tui implements Iface, Observer {
         return true;
     }
 
+    //Effect: main loop of program, displays menu, get input and execute functions
     public void demo() {
         System.out.println(" Welcome to " + Const.PROGRAM_NAME + "!");
         boolean cont = true;
@@ -182,6 +191,7 @@ public class Tui implements Iface, Observer {
         }
     }
 
+    //Effect: reprint the list when the list is updated, or if stocks are added or deleted
     @Override
     public void update(Observable obsed, Object event) {
         printWatchList();

src/main/ui/guicomp/AddButt.java

@@ -22,7 +22,6 @@ public class AddButt extends JButton {
         public void actionPerformed(ActionEvent e) {
             //https://docs.oracle.com/javase/tutorial/uiswing/components/dialog.html#input
             //https://docs.oracle.com/javase/7/docs/api/javax/swing/JOptionPane.html
-            System.out.println("Count of listeners: " + ((JButton) e.getSource()).getActionListeners().length);
             String userin = (String)JOptionPane.showInputDialog("Enter the identifier:");
             if ((userin != null) && (userin.length() > 0)) {
                 new Thread(new Runnable() {

src/main/ui/guicomp/WatchTableModel.java

@@ -34,6 +34,7 @@ public class WatchTableModel extends AbstractTableModel implements Observer {
         return colnames[num];
     }
 
+    //Effect: return generated table data for whatever asked
     public Object getValueAt(int stock, int field) {
         StockEntry entry = watch.getStock(stock);
         switch (field) {
@@ -54,6 +55,8 @@ public class WatchTableModel extends AbstractTableModel implements Observer {
         return example[col].getClass();
     }
 
+    //Effect: updates table for different events, ran by event dispatch thread as recommanded
+    //Modifies: Table displayed
     @Override
     public void update(Observable obsed, Object event) {
         Wevent weve = (Wevent) event;

src/test/data/DataSourceTest.java

@@ -18,6 +18,7 @@ public class DataSourceTest {
         testSource = new AlphaVantage();
     }
 
+    //Effect: test add and double deleting for many to many relationship
     @Test
     public void testAddDel() {
         testStype.addSource(testSource);
@@ -25,6 +26,7 @@ public class DataSourceTest {
         testSource.delStype(testStype);
     }
 
+    //Effect: test overridden equals and hashcode
     @Test
     public void testEqualsHash() {
         DataSource testSource2 = new AlphaVantage();

src/test/data/ListOfWatchListTest.java

@@ -18,11 +18,13 @@ public class ListOfWatchListTest {
         watchlist = new WatchList();
     }
 
+    //Effect: check if only one instance is returned
     @Test
     public void singletonCheck() {
         assertTrue(ListOfWatchList.getList() == ListOfWatchList.getList());
     }
 
+    //Effect: check double adding and deleting watchlists
     @Test
     public void addDelWatchList() {
         ListOfWatchList lowl = ListOfWatchList.getList();

src/test/data/NasdaqTest.java

@@ -14,16 +14,19 @@ public class NasdaqTest {
     private StockType naasdaq;
 
     @BeforeEach
+    // Effect: Initialize Stype
     public void runBefore() {
         naasdaq = StypeMap.getStype("NASDAQ");
     }
 
     @Test
+    //Effect: test if name matches
     public void testName() {
         assertTrue(naasdaq.getName().equals("NASDAQ"));
     }
 
     @Test
+    //Effect: check (indirectly) if update works, require internet to AlphaVantage
     public void testUpdate() {
         try {
             double[] farray = naasdaq.update("MSFT");

src/test/data/NyseTest.java

@@ -18,11 +18,14 @@ public class NyseTest {
         nyyyse = StypeMap.getStype("NYSE");
     }
 
+    //Effect: test constructor and if name matches
     @Test
     public void testNameInit() {
         assertTrue(nyyyse.getName().equals("NYSE"));
     }
 
+    //Effect: will connect to the internet and test update
+    //Require: internet connection to AlphaVantage.co
     @Test
     public void testUpdate() {
         try {
@@ -32,6 +35,7 @@ public class NyseTest {
         }
     }
 
+    //Effect: test overridden equals and hashcode
     @Test
     public void testEqualsHash() {
         StockType testst1 = new Nyse();	

src/test/data/StockEntryTest.java

@@ -21,6 +21,7 @@ public class StockEntryTest {
         nyyyse = StypeMap.getStype("NYSE");
     }
 
+    //Effect: test constructor, two getters and default 0 price
     @Test
     public void testTypeAndName() {
         entry = new StockEntry(nyyyse, "test");
@@ -31,6 +32,7 @@ public class StockEntryTest {
         assertEquals(0, entry.getChange());
     }
 
+    //Effect: test overridden equals and hashcode
     @Test
     public void testEqualsHash() {
         entry = new StockEntry(nyyyse, "test");

src/test/data/StypeMapTest.java

@@ -11,11 +11,8 @@ import static org.junit.jupiter.api.Assertions.assertTrue;
 
 public class StypeMapTest {
 
-    @BeforeEach
-    public void runBefore() {
-    }
-
     @Test
+    //Effect: Test if Stype NYSE exists in StypeMap
     public void testGetStype() {
         StockType stype = StypeMap.getStype("NYSE");
         assertEquals(stype.getName(), "NYSE");

src/test/data/WatchListTest.java

@@ -22,6 +22,8 @@ public class WatchListTest {
         watchlist = new WatchList();
     }
 
+    //Effect: add stock named 1 to 100 to watchlist, test if index is keep
+    //counting up and if getNames() works
     @Test
     public void testAddStockNames() {
         String[] testarray = new String[100];
@@ -39,6 +41,7 @@ public class WatchListTest {
         }
     }
 
+    //Effect: test size function for 100 stocks
     @Test
     public void testSize() {
         assertEquals(watchlist.size(), 0);