Merge pull request #57 from RancyKaur/RancyBranch2

Added Negotiate card implementation and updated javadoc
RancyKaur · Nov 6, 2023 · b84e472 · b84e472
2 parents 925086e + 7175356
commit b84e472
Show file tree

Hide file tree

Showing 173 changed files with 4,887 additions and 11,299 deletions.
diff --git a/Docs/Documentation_JavaDoc/Controller/GameEngine.html b/Docs/Documentation_JavaDoc/Controller/GameEngine.html
diff --git a/Documentation_JavaDoc/Test/TestDeploy.html → ...ntation_JavaDoc/Controller/LogWriter.html b/Documentation_JavaDoc/Test/TestDeploy.html → ...ntation_JavaDoc/Controller/LogWriter.html
@@ -1,12 +1,12 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Fri Oct 27 16:01:35 EDT 2023 -->
-<title>TestDeploy</title>
+<!-- Generated by javadoc (17) on Sun Nov 05 20:04:48 EST 2023 -->
+<title>LogWriter</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2023-10-27">
-<meta name="description" content="declaration: package: Test, class: TestDeploy">
+<meta name="dc.created" content="2023-11-05">
+<meta name="description" content="declaration: package: Controller, class: LogWriter">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
@@ -68,21 +68,22 @@
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
-<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">Test</a></div>
-<h1 title="Class TestDeploy" class="title">Class TestDeploy</h1>
+<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">Controller</a></div>
+<h1 title="Class LogWriter" class="title">Class LogWriter</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
-<div class="inheritance">Test.TestDeploy</div>
+<div class="inheritance">Controller.LogWriter</div>
 </div>
 <section class="class-description" id="class-description">
-<hr>
-<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">TestDeploy</span>
-<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
-<div class="block">Test deploy operation for a specific player in Game</div>
 <dl class="notes">
-<dt>Author:</dt>
-<dd>Rahul</dd>
+<dt>All Implemented Interfaces:</dt>
+<dd><code><a href="../Model/Observer.html" title="interface in Model">Observer</a></code></dd>
 </dl>
+<hr>
+<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">LogWriter</span>
+<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
+implements <a href="../Model/Observer.html" title="interface in Model">Observer</a></span></div>
+<div class="block">class to implement the logging of events to a log file.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
@@ -94,8 +95,10 @@ <h2>Constructor Summary</h2>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
-<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">TestDeploy</a>()</code></div>
-<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">LogWriter</a>()</code></div>
+<div class="col-last even-row-color">
+<div class="block">Constructor for initializing FileWriter and BufferedWriter</div>
+</div>
 </div>
 </section>
 </li>
@@ -111,9 +114,9 @@ <h2>Method Summary</h2>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
-<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#before()" class="member-name-link">before</a>()</code></div>
+<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#workUpdate(Model.Observable)" class="member-name-link">workUpdate</a><wbr>(<a href="../Model/Observable.html" title="class in Model">Observable</a>&nbsp;p_observable)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">initial setup</div>
+<div class="block">On change of state in Observable ,the observer function is called.</div>
 </div>
 </div>
 </div>
@@ -134,8 +137,9 @@ <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="&lt;init&gt;()">
-<h3>TestDeploy</h3>
-<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">TestDeploy</span>()</div>
+<h3>LogWriter</h3>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">LogWriter</span>()</div>
+<div class="block">Constructor for initializing FileWriter and BufferedWriter</div>
 </section>
 </li>
 </ul>
@@ -147,10 +151,18 @@ <h3>TestDeploy</h3>
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
-<section class="detail" id="before()">
-<h3>before</h3>
-<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">before</span>()</div>
-<div class="block">initial setup</div>
+<section class="detail" id="workUpdate(Model.Observable)">
+<h3>workUpdate</h3>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">workUpdate</span><wbr><span class="parameters">(<a href="../Model/Observable.html" title="class in Model">Observable</a>&nbsp;p_observable)</span></div>
+<div class="block">On change of state in Observable ,the observer function is called.
+ Tracks changes of phase,command and command effect and updates them in a log file
+ using filewriter.</div>
+<dl class="notes">
+<dt>Specified by:</dt>
+<dd><code><a href="../Model/Observer.html#workUpdate(Model.Observable)">workUpdate</a></code>&nbsp;in interface&nbsp;<code><a href="../Model/Observer.html" title="interface in Model">Observer</a></code></dd>
+<dt>Parameters:</dt>
+<dd><code>p_observable</code> - Observable,in this game it is LogEntryBuffer</dd>
+</dl>
 </section>
 </li>
 </ul>

diff --git a/Docs/Documentation_JavaDoc/Controller/package-summary.html b/Docs/Documentation_JavaDoc/Controller/package-summary.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Wed Oct 04 23:25:35 EDT 2023 -->
+<!-- Generated by javadoc (17) on Sun Nov 05 20:04:48 EST 2023 -->
 <title>Controller</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2023-10-04">
+<meta name="dc.created" content="2023-11-05">
 <meta name="description" content="declaration: package: Controller">
 <meta name="generator" content="javadoc/PackageWriterImpl">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -61,7 +61,7 @@ <h1 title="Package Controller" class="title">Package Controller</h1>
 <hr>
 <div class="package-signature">package <span class="element-name">Controller</span></div>
 <section class="package-description" id="package-description">
-<div class="block">Package contains class to handle the commands issued by player</div>
+<div class="block">Test if the commands issued by player can be handled properly</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
@@ -72,7 +72,13 @@ <h1 title="Package Controller" class="title">Package Controller</h1>
 <div class="table-header col-first">Class</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color class-summary class-summary-tab2"><a href="GameEngine.html" title="class in Controller">GameEngine</a></div>
-<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
+<div class="col-last even-row-color class-summary class-summary-tab2">
+<div class="block">This class manages game phases, player actions, and map editing.</div>
+</div>
+<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LogWriter.html" title="class in Controller">LogWriter</a></div>
+<div class="col-last odd-row-color class-summary class-summary-tab2">
+<div class="block">class to implement the logging of events to a log file.</div>
+</div>
 </div>
 </div>
 </li>

diff --git a/Docs/Documentation_JavaDoc/Controller/package-tree.html b/Docs/Documentation_JavaDoc/Controller/package-tree.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Wed Oct 04 23:25:35 EDT 2023 -->
+<!-- Generated by javadoc (17) on Sun Nov 05 20:04:48 EST 2023 -->
 <title>Controller Class Hierarchy</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2023-10-04">
+<meta name="dc.created" content="2023-11-05">
 <meta name="description" content="tree: package: Controller">
 <meta name="generator" content="javadoc/PackageTreeWriter">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -60,6 +60,7 @@ <h2 title="Class Hierarchy">Class Hierarchy</h2>
 <li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
 <ul>
 <li class="circle">Controller.<a href="GameEngine.html" class="type-name-link" title="class in Controller">GameEngine</a></li>
+<li class="circle">Controller.<a href="LogWriter.html" class="type-name-link" title="class in Controller">LogWriter</a> (implements Model.<a href="../Model/Observer.html" title="interface in Model">Observer</a>)</li>
 </ul>
 </li>
 </ul>