Skip to content
This repository was archived by the owner on Mar 23, 2025. It is now read-only.

Commit 44d45d2

Browse files
seanoccaseanocca
committed
Added Javadoc
1 parent fa2bb27 commit 44d45d2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+15878
-5478
lines changed

‎doc/Delivery/Manifest.html

+324
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,324 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<!-- NewPage -->
3+
<html lang="en">
4+
<head>
5+
<!-- Generated by javadoc (1.8.0_161) on Mon May 28 00:01:51 AEST 2018 -->
6+
<title>Manifest</title>
7+
<meta name="date" content="2018-05-28">
8+
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
9+
<script type="text/javascript" src="../script.js"></script>
10+
</head>
11+
<body>
12+
<script type="text/javascript"><!--
13+
try {
14+
if (location.href.indexOf('is-external=true') == -1) {
15+
parent.document.title="Manifest";
16+
}
17+
}
18+
catch(err) {
19+
}
20+
//-->
21+
var methods = {"i0":10,"i1":10};
22+
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
23+
var altColor = "altColor";
24+
var rowColor = "rowColor";
25+
var tableTab = "tableTab";
26+
var activeTableTab = "activeTableTab";
27+
</script>
28+
<noscript>
29+
<div>JavaScript is disabled on your browser.</div>
30+
</noscript>
31+
<!-- ========= START OF TOP NAVBAR ======= -->
32+
<div class="topNav"><a name="navbar.top">
33+
<!-- -->
34+
</a>
35+
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36+
<a name="navbar.top.firstrow">
37+
<!-- -->
38+
</a>
39+
<ul class="navList" title="Navigation">
40+
<li><a href="../overview-summary.html">Overview</a></li>
41+
<li><a href="package-summary.html">Package</a></li>
42+
<li class="navBarCell1Rev">Class</li>
43+
<li><a href="class-use/Manifest.html">Use</a></li>
44+
<li><a href="package-tree.html">Tree</a></li>
45+
<li><a href="../deprecated-list.html">Deprecated</a></li>
46+
<li><a href="../index-files/index-1.html">Index</a></li>
47+
<li><a href="../help-doc.html">Help</a></li>
48+
</ul>
49+
</div>
50+
<div class="subNav">
51+
<ul class="navList">
52+
<li>Prev&nbsp;Class</li>
53+
<li><a href="../Delivery/ManifestTest.html" title="class in Delivery"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54+
</ul>
55+
<ul class="navList">
56+
<li><a href="../index.html?Delivery/Manifest.html" target="_top">Frames</a></li>
57+
<li><a href="Manifest.html" target="_top">No&nbsp;Frames</a></li>
58+
</ul>
59+
<ul class="navList" id="allclasses_navbar_top">
60+
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
61+
</ul>
62+
<div>
63+
<script type="text/javascript"><!--
64+
allClassesLink = document.getElementById("allclasses_navbar_top");
65+
if(window==top) {
66+
allClassesLink.style.display = "block";
67+
}
68+
else {
69+
allClassesLink.style.display = "none";
70+
}
71+
//-->
72+
</script>
73+
</div>
74+
<div>
75+
<ul class="subNavList">
76+
<li>Summary:&nbsp;</li>
77+
<li>Nested&nbsp;|&nbsp;</li>
78+
<li>Field&nbsp;|&nbsp;</li>
79+
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
80+
<li><a href="#method.summary">Method</a></li>
81+
</ul>
82+
<ul class="subNavList">
83+
<li>Detail:&nbsp;</li>
84+
<li>Field&nbsp;|&nbsp;</li>
85+
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
86+
<li><a href="#method.detail">Method</a></li>
87+
</ul>
88+
</div>
89+
<a name="skip.navbar.top">
90+
<!-- -->
91+
</a></div>
92+
<!-- ========= END OF TOP NAVBAR ========= -->
93+
<!-- ======== START OF CLASS DATA ======== -->
94+
<div class="header">
95+
<div class="subTitle">Delivery</div>
96+
<h2 title="Class Manifest" class="title">Class Manifest</h2>
97+
</div>
98+
<div class="contentContainer">
99+
<ul class="inheritance">
100+
<li>java.lang.Object</li>
101+
<li>
102+
<ul class="inheritance">
103+
<li>Delivery.Manifest</li>
104+
</ul>
105+
</li>
106+
</ul>
107+
<div class="description">
108+
<ul class="blockList">
109+
<li class="blockList">
110+
<hr>
111+
<br>
112+
<pre>public class <span class="typeNameLabel">Manifest</span>
113+
extends java.lang.Object</pre>
114+
<div class="block">The manifest is created to use for the list of trucks and the creation of it</div>
115+
<dl>
116+
<dt><span class="simpleTagLabel">Author:</span></dt>
117+
<dd>Sean O'Connell</dd>
118+
</dl>
119+
</li>
120+
</ul>
121+
</div>
122+
<div class="summary">
123+
<ul class="blockList">
124+
<li class="blockList">
125+
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
126+
<ul class="blockList">
127+
<li class="blockList"><a name="constructor.summary">
128+
<!-- -->
129+
</a>
130+
<h3>Constructor Summary</h3>
131+
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
132+
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
133+
<tr>
134+
<th class="colOne" scope="col">Constructor and Description</th>
135+
</tr>
136+
<tr class="altColor">
137+
<td class="colOne"><code><span class="memberNameLink"><a href="../Delivery/Manifest.html#Manifest-Stock.Stock-">Manifest</a></span>(<a href="../Stock/Stock.html" title="class in Stock">Stock</a>&nbsp;cargo)</code>
138+
<div class="block">Creates the Manifest and it takes a Stock
139+
Creates an array of Trucks both Refrigerated and Ordinary</div>
140+
</td>
141+
</tr>
142+
</table>
143+
</li>
144+
</ul>
145+
<!-- ========== METHOD SUMMARY =========== -->
146+
<ul class="blockList">
147+
<li class="blockList"><a name="method.summary">
148+
<!-- -->
149+
</a>
150+
<h3>Method Summary</h3>
151+
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
152+
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
153+
<tr>
154+
<th class="colFirst" scope="col">Modifier and Type</th>
155+
<th class="colLast" scope="col">Method and Description</th>
156+
</tr>
157+
<tr id="i0" class="altColor">
158+
<td class="colFirst"><code>java.util.ArrayList&lt;<a href="../Delivery/Truck.html" title="class in Delivery">Truck</a>&gt;</code></td>
159+
<td class="colLast"><code><span class="memberNameLink"><a href="../Delivery/Manifest.html#GetManifestArray--">GetManifestArray</a></span>()</code>
160+
<div class="block">Gets the manifest as an array of Trucks
161+
for all the for each loops in the GUI</div>
162+
</td>
163+
</tr>
164+
<tr id="i1" class="rowColor">
165+
<td class="colFirst"><code>double</code></td>
166+
<td class="colLast"><code><span class="memberNameLink"><a href="../Delivery/Manifest.html#GetManifestCost--">GetManifestCost</a></span>()</code>
167+
<div class="block">Get the Cost of the Truck and the cost of each Item in the truck
168+
For each truck in the manifest</div>
169+
</td>
170+
</tr>
171+
</table>
172+
<ul class="blockList">
173+
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
174+
<!-- -->
175+
</a>
176+
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
177+
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
178+
</ul>
179+
</li>
180+
</ul>
181+
</li>
182+
</ul>
183+
</div>
184+
<div class="details">
185+
<ul class="blockList">
186+
<li class="blockList">
187+
<!-- ========= CONSTRUCTOR DETAIL ======== -->
188+
<ul class="blockList">
189+
<li class="blockList"><a name="constructor.detail">
190+
<!-- -->
191+
</a>
192+
<h3>Constructor Detail</h3>
193+
<a name="Manifest-Stock.Stock-">
194+
<!-- -->
195+
</a>
196+
<ul class="blockListLast">
197+
<li class="blockList">
198+
<h4>Manifest</h4>
199+
<pre>public&nbsp;Manifest(<a href="../Stock/Stock.html" title="class in Stock">Stock</a>&nbsp;cargo)
200+
throws <a href="../Exceptions/DeliveryException.html" title="class in Exceptions">DeliveryException</a>,
201+
<a href="../Exceptions/StockException.html" title="class in Exceptions">StockException</a></pre>
202+
<div class="block">Creates the Manifest and it takes a Stock
203+
Creates an array of Trucks both Refrigerated and Ordinary</div>
204+
<dl>
205+
<dt><span class="paramLabel">Parameters:</span></dt>
206+
<dd><code>cargo</code> - </dd>
207+
<dt><span class="throwsLabel">Throws:</span></dt>
208+
<dd><code><a href="../Exceptions/StockException.html" title="class in Exceptions">StockException</a></code></dd>
209+
<dd><code><a href="../Exceptions/DeliveryException.html" title="class in Exceptions">DeliveryException</a></code></dd>
210+
</dl>
211+
</li>
212+
</ul>
213+
</li>
214+
</ul>
215+
<!-- ============ METHOD DETAIL ========== -->
216+
<ul class="blockList">
217+
<li class="blockList"><a name="method.detail">
218+
<!-- -->
219+
</a>
220+
<h3>Method Detail</h3>
221+
<a name="GetManifestArray--">
222+
<!-- -->
223+
</a>
224+
<ul class="blockList">
225+
<li class="blockList">
226+
<h4>GetManifestArray</h4>
227+
<pre>public&nbsp;java.util.ArrayList&lt;<a href="../Delivery/Truck.html" title="class in Delivery">Truck</a>&gt;&nbsp;GetManifestArray()</pre>
228+
<div class="block">Gets the manifest as an array of Trucks
229+
for all the for each loops in the GUI</div>
230+
<dl>
231+
<dt><span class="returnLabel">Returns:</span></dt>
232+
<dd>trucks</dd>
233+
</dl>
234+
</li>
235+
</ul>
236+
<a name="GetManifestCost--">
237+
<!-- -->
238+
</a>
239+
<ul class="blockListLast">
240+
<li class="blockList">
241+
<h4>GetManifestCost</h4>
242+
<pre>public&nbsp;double&nbsp;GetManifestCost()
243+
throws <a href="../Exceptions/DeliveryException.html" title="class in Exceptions">DeliveryException</a></pre>
244+
<div class="block">Get the Cost of the Truck and the cost of each Item in the truck
245+
For each truck in the manifest</div>
246+
<dl>
247+
<dt><span class="returnLabel">Returns:</span></dt>
248+
<dd>cost</dd>
249+
<dt><span class="throwsLabel">Throws:</span></dt>
250+
<dd><code><a href="../Exceptions/DeliveryException.html" title="class in Exceptions">DeliveryException</a></code></dd>
251+
</dl>
252+
</li>
253+
</ul>
254+
</li>
255+
</ul>
256+
</li>
257+
</ul>
258+
</div>
259+
</div>
260+
<!-- ========= END OF CLASS DATA ========= -->
261+
<!-- ======= START OF BOTTOM NAVBAR ====== -->
262+
<div class="bottomNav"><a name="navbar.bottom">
263+
<!-- -->
264+
</a>
265+
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
266+
<a name="navbar.bottom.firstrow">
267+
<!-- -->
268+
</a>
269+
<ul class="navList" title="Navigation">
270+
<li><a href="../overview-summary.html">Overview</a></li>
271+
<li><a href="package-summary.html">Package</a></li>
272+
<li class="navBarCell1Rev">Class</li>
273+
<li><a href="class-use/Manifest.html">Use</a></li>
274+
<li><a href="package-tree.html">Tree</a></li>
275+
<li><a href="../deprecated-list.html">Deprecated</a></li>
276+
<li><a href="../index-files/index-1.html">Index</a></li>
277+
<li><a href="../help-doc.html">Help</a></li>
278+
</ul>
279+
</div>
280+
<div class="subNav">
281+
<ul class="navList">
282+
<li>Prev&nbsp;Class</li>
283+
<li><a href="../Delivery/ManifestTest.html" title="class in Delivery"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
284+
</ul>
285+
<ul class="navList">
286+
<li><a href="../index.html?Delivery/Manifest.html" target="_top">Frames</a></li>
287+
<li><a href="Manifest.html" target="_top">No&nbsp;Frames</a></li>
288+
</ul>
289+
<ul class="navList" id="allclasses_navbar_bottom">
290+
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
291+
</ul>
292+
<div>
293+
<script type="text/javascript"><!--
294+
allClassesLink = document.getElementById("allclasses_navbar_bottom");
295+
if(window==top) {
296+
allClassesLink.style.display = "block";
297+
}
298+
else {
299+
allClassesLink.style.display = "none";
300+
}
301+
//-->
302+
</script>
303+
</div>
304+
<div>
305+
<ul class="subNavList">
306+
<li>Summary:&nbsp;</li>
307+
<li>Nested&nbsp;|&nbsp;</li>
308+
<li>Field&nbsp;|&nbsp;</li>
309+
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
310+
<li><a href="#method.summary">Method</a></li>
311+
</ul>
312+
<ul class="subNavList">
313+
<li>Detail:&nbsp;</li>
314+
<li>Field&nbsp;|&nbsp;</li>
315+
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
316+
<li><a href="#method.detail">Method</a></li>
317+
</ul>
318+
</div>
319+
<a name="skip.navbar.bottom">
320+
<!-- -->
321+
</a></div>
322+
<!-- ======== END OF BOTTOM NAVBAR ======= -->
323+
</body>
324+
</html>

0 commit comments

Comments
 (0)