Skip to content

Commit 225faa5

Browse files
jkeeshjkeesh
committed
update files
1 parent 76eca3e commit 225faa5

24 files changed

Lines changed: 148 additions & 35 deletions

‎.DS_Store‎

0 Bytes
Binary file not shown.

‎README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,10 @@
11
# codehs-java-library
2+
3+
4+
How to use:
5+
6+
* Always stay on and push to the gh-pages branch.
7+
* The public site lives at: http://codehs.github.io/codehs-java-library
8+
* For Jeremy, the Eclipse project with the files lives in CodeHSLibrary
9+
* In Eclipse, generate the latest Javadocs with Project/Generate Javadoc command
10+
* Copy over and replace the doc and src fodl

‎doc/ConsoleProgram.html‎

Lines changed: 60 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_45) on Thu Aug 13 17:55:50 PDT 2015 -->
5+
<!-- Generated by javadoc (1.8.0_45) on Thu Aug 13 18:11:26 PDT 2015 -->
66
<title>ConsoleProgram</title>
77
<meta name="date" content="2015-08-13">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -127,7 +127,9 @@ <h3>Constructor Summary</h3>
127127
<th class="colOne" scope="col">Constructor and Description</th>
128128
</tr>
129129
<tr class="altColor">
130-
<td class="colOne"><code><span class="memberNameLink"><a href="ConsoleProgram.html#ConsoleProgram--">ConsoleProgram</a></span>()</code>&nbsp;</td>
130+
<td class="colOne"><code><span class="memberNameLink"><a href="ConsoleProgram.html#ConsoleProgram--">ConsoleProgram</a></span>()</code>
131+
<div class="block">Constructor for Console program.</div>
132+
</td>
131133
</tr>
132134
</table>
133135
</li>
@@ -150,23 +152,34 @@ <h3>Method Summary</h3>
150152
</tr>
151153
<tr id="i1" class="rowColor">
152154
<td class="colFirst"><code>boolean</code></td>
153-
<td class="colLast"><code><span class="memberNameLink"><a href="ConsoleProgram.html#readBoolean-java.lang.String-">readBoolean</a></span>(java.lang.String&nbsp;prompt)</code>&nbsp;</td>
155+
<td class="colLast"><code><span class="memberNameLink"><a href="ConsoleProgram.html#readBoolean-java.lang.String-">readBoolean</a></span>(java.lang.String&nbsp;prompt)</code>
156+
<div class="block">This method reads a boolean value from the user, asking them for either
157+
a true or false value.</div>
158+
</td>
154159
</tr>
155160
<tr id="i2" class="altColor">
156161
<td class="colFirst"><code>double</code></td>
157-
<td class="colLast"><code><span class="memberNameLink"><a href="ConsoleProgram.html#readDouble-java.lang.String-">readDouble</a></span>(java.lang.String&nbsp;prompt)</code>&nbsp;</td>
162+
<td class="colLast"><code><span class="memberNameLink"><a href="ConsoleProgram.html#readDouble-java.lang.String-">readDouble</a></span>(java.lang.String&nbsp;prompt)</code>
163+
<div class="block">This method reads a double value from the user, given a prompt.</div>
164+
</td>
158165
</tr>
159166
<tr id="i3" class="rowColor">
160167
<td class="colFirst"><code>int</code></td>
161-
<td class="colLast"><code><span class="memberNameLink"><a href="ConsoleProgram.html#readInt-java.lang.String-">readInt</a></span>(java.lang.String&nbsp;prompt)</code>&nbsp;</td>
168+
<td class="colLast"><code><span class="memberNameLink"><a href="ConsoleProgram.html#readInt-java.lang.String-">readInt</a></span>(java.lang.String&nbsp;prompt)</code>
169+
<div class="block">This method reads a int value from the user, given a prompt.</div>
170+
</td>
162171
</tr>
163172
<tr id="i4" class="altColor">
164173
<td class="colFirst"><code>java.lang.String</code></td>
165-
<td class="colLast"><code><span class="memberNameLink"><a href="ConsoleProgram.html#readLine-java.lang.String-">readLine</a></span>(java.lang.String&nbsp;prompt)</code>&nbsp;</td>
174+
<td class="colLast"><code><span class="memberNameLink"><a href="ConsoleProgram.html#readLine-java.lang.String-">readLine</a></span>(java.lang.String&nbsp;prompt)</code>
175+
<div class="block">This method reads a line of input from the user, given a prompt.</div>
176+
</td>
166177
</tr>
167178
<tr id="i5" class="rowColor">
168179
<td class="colFirst"><code>void</code></td>
169-
<td class="colLast"><code><span class="memberNameLink"><a href="ConsoleProgram.html#run--">run</a></span>()</code>&nbsp;</td>
180+
<td class="colLast"><code><span class="memberNameLink"><a href="ConsoleProgram.html#run--">run</a></span>()</code>
181+
<div class="block">The run method is overwritten by the subclass.</div>
182+
</td>
170183
</tr>
171184
</table>
172185
<ul class="blockList">
@@ -197,6 +210,7 @@ <h3>Constructor Detail</h3>
197210
<li class="blockList">
198211
<h4>ConsoleProgram</h4>
199212
<pre>public&nbsp;ConsoleProgram()</pre>
213+
<div class="block">Constructor for Console program. Create a scanner instance to be used for user input.</div>
200214
</li>
201215
</ul>
202216
</li>
@@ -223,6 +237,16 @@ <h4>main</h4>
223237
<li class="blockList">
224238
<h4>run</h4>
225239
<pre>public&nbsp;void&nbsp;run()</pre>
240+
<div class="block">The run method is overwritten by the subclass. This is the main entry point for
241+
ConsolePrograms. There is no main method in student programs that extend ConsoleProgram,
242+
instead they write their application starting like this:
243+
244+
public void run()
245+
{
246+
// student code here
247+
}
248+
249+
The main method of ConsoleProgram calls this run method when it begins.</div>
226250
</li>
227251
</ul>
228252
<a name="readLine-java.lang.String-">
@@ -232,6 +256,13 @@ <h4>run</h4>
232256
<li class="blockList">
233257
<h4>readLine</h4>
234258
<pre>public&nbsp;java.lang.String&nbsp;readLine(java.lang.String&nbsp;prompt)</pre>
259+
<div class="block">This method reads a line of input from the user, given a prompt.</div>
260+
<dl>
261+
<dt><span class="paramLabel">Parameters:</span></dt>
262+
<dd><code>prompt</code> - A prompt to the user to get input</dd>
263+
<dt><span class="returnLabel">Returns:</span></dt>
264+
<dd>A String of the user input.</dd>
265+
</dl>
235266
</li>
236267
</ul>
237268
<a name="readBoolean-java.lang.String-">
@@ -241,6 +272,14 @@ <h4>readLine</h4>
241272
<li class="blockList">
242273
<h4>readBoolean</h4>
243274
<pre>public&nbsp;boolean&nbsp;readBoolean(java.lang.String&nbsp;prompt)</pre>
275+
<div class="block">This method reads a boolean value from the user, asking them for either
276+
a true or false value. This makes use of the readLine method.</div>
277+
<dl>
278+
<dt><span class="paramLabel">Parameters:</span></dt>
279+
<dd><code>prompt</code> - A prompt to the user to read a boolean value</dd>
280+
<dt><span class="returnLabel">Returns:</span></dt>
281+
<dd>A boolean value read from the user.</dd>
282+
</dl>
244283
</li>
245284
</ul>
246285
<a name="readDouble-java.lang.String-">
@@ -250,6 +289,13 @@ <h4>readBoolean</h4>
250289
<li class="blockList">
251290
<h4>readDouble</h4>
252291
<pre>public&nbsp;double&nbsp;readDouble(java.lang.String&nbsp;prompt)</pre>
292+
<div class="block">This method reads a double value from the user, given a prompt.</div>
293+
<dl>
294+
<dt><span class="paramLabel">Parameters:</span></dt>
295+
<dd><code>prompt</code> - A prompt to the user to ask for a a double.</dd>
296+
<dt><span class="returnLabel">Returns:</span></dt>
297+
<dd>A double value read from the user.</dd>
298+
</dl>
253299
</li>
254300
</ul>
255301
<a name="readInt-java.lang.String-">
@@ -259,6 +305,13 @@ <h4>readDouble</h4>
259305
<li class="blockList">
260306
<h4>readInt</h4>
261307
<pre>public&nbsp;int&nbsp;readInt(java.lang.String&nbsp;prompt)</pre>
308+
<div class="block">This method reads a int value from the user, given a prompt.</div>
309+
<dl>
310+
<dt><span class="paramLabel">Parameters:</span></dt>
311+
<dd><code>prompt</code> - A prompt to the user to ask for an int</dd>
312+
<dt><span class="returnLabel">Returns:</span></dt>
313+
<dd>The int value read from the user.</dd>
314+
</dl>
262315
</li>
263316
</ul>
264317
</li>

‎doc/Randomizer.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_45) on Thu Aug 13 17:55:50 PDT 2015 -->
5+
<!-- Generated by javadoc (1.8.0_45) on Thu Aug 13 18:11:26 PDT 2015 -->
66
<title>Randomizer</title>
77
<meta name="date" content="2015-08-13">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

‎doc/allclasses-frame.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_45) on Thu Aug 13 17:55:50 PDT 2015 -->
5+
<!-- Generated by javadoc (1.8.0_45) on Thu Aug 13 18:11:26 PDT 2015 -->
66
<title>All Classes</title>
77
<meta name="date" content="2015-08-13">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

‎doc/allclasses-noframe.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_45) on Thu Aug 13 17:55:50 PDT 2015 -->
5+
<!-- Generated by javadoc (1.8.0_45) on Thu Aug 13 18:11:26 PDT 2015 -->
66
<title>All Classes</title>
77
<meta name="date" content="2015-08-13">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

‎doc/class-use/ConsoleProgram.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_45) on Thu Aug 13 17:55:50 PDT 2015 -->
5+
<!-- Generated by javadoc (1.8.0_45) on Thu Aug 13 18:11:26 PDT 2015 -->
66
<title>Uses of Class ConsoleProgram</title>
77
<meta name="date" content="2015-08-13">
88
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

‎doc/class-use/Randomizer.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_45) on Thu Aug 13 17:55:50 PDT 2015 -->
5+
<!-- Generated by javadoc (1.8.0_45) on Thu Aug 13 18:11:26 PDT 2015 -->
66
<title>Uses of Class Randomizer</title>
77
<meta name="date" content="2015-08-13">
88
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

‎doc/constant-values.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_45) on Thu Aug 13 17:55:50 PDT 2015 -->
5+
<!-- Generated by javadoc (1.8.0_45) on Thu Aug 13 18:11:26 PDT 2015 -->
66
<title>Constant Field Values</title>
77
<meta name="date" content="2015-08-13">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

‎doc/deprecated-list.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_45) on Thu Aug 13 17:55:50 PDT 2015 -->
5+
<!-- Generated by javadoc (1.8.0_45) on Thu Aug 13 18:11:26 PDT 2015 -->
66
<title>Deprecated List</title>
77
<meta name="date" content="2015-08-13">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

0 commit comments

Comments
 (0)