ConsoleProgram

From 63d5860d29cfbd329a31eb7ea11b73f457ff0cf3 Mon Sep 17 00:00:00 2001 From: anderoonies Date: Thu, 18 Oct 2018 15:52:15 -0400 Subject: [PATCH] update consoleprogram and randomizer --- doc/ConsoleProgram.html | 632 ++++++++++++++++++++++++++++++++++------ doc/Randomizer.html | 102 ++++--- src/ConsoleProgram.java | 345 ++++++++++++++-------- src/Randomizer.java | 153 +++++----- 4 files changed, 913 insertions(+), 319 deletions(-) diff --git a/doc/ConsoleProgram.html b/doc/ConsoleProgram.html index 40abb93..19bb28a 100644 --- a/doc/ConsoleProgram.html +++ b/doc/ConsoleProgram.html @@ -2,28 +2,60 @@ - + ConsoleProgram - +

JavaScript is disabled on your browser.

Package

Class

Prev Class
Next Class
Prev Class
Next Class

Frames

@@ -128,7 +158,8 @@

Constructor Summary

ConsoleProgram() -

Constructor for Console program.

Setups a new Scanner for System.in and the inputs variable for storring + inputs.

@@ -147,38 +178,171 @@

Method Summary

Method and Description -static void -main(java.lang.String[] args) +void +addInput(java.lang.String s) +

Allows you to add an input to your inputs.

+ +static void +main(java.lang.String[] args) +

ConsoleProgram can also be run as the main class.

+ + + +void +print() +

Allows us to use a shorthand version for System.out.print()

+ + + +void +print(boolean x) +

Allows us to use a shorthand version for System.out.print(boolean x)

+ + + +void +print(char x) +

Allows us to use a shorthand version for System.out.print(char x)

+ + + +void +print(char[] x) +

Allows us to use a shorthand version for System.out.print(char[] x)

+ + + +void +print(double x) +

Allows us to use a shorthand version for System.out.print(double x)

+ + + +void +print(float x) +

Allows us to use a shorthand version for System.out.print(float x)

+ + + +void +print(int x) +

Allows us to use a shorthand version for System.out.print(int x)

+ + + +void +print(long x) +

Allows us to use a shorthand version for System.out.print(long x)

+ + + +void +print(java.lang.Object o) +

Allows us to use a shorthand version for System.out.print(Object o)

+ + + +void +print(java.lang.String s) +

Allows us to use a shorthand version for System.out.print(String s)

+ + + +void +println() +

Allows us to use a shorthand version for System.out.println()

+ + + +void +println(boolean x) +

Allows us to use a shorthand version for System.out.println(boolean x)

+ + + +void +println(char x) +

Allows us to use a shorthand version for System.out.println(char x)

+ + + +void +println(char[] x) +

Allows us to use a shorthand version for System.out.println(char[] x)

+ + + +void +println(double x) +

Allows us to use a shorthand version for System.out.println(double x)

+ + + +void +println(float x) +

Allows us to use a shorthand version for System.out.println(float x)

+ + + +void +println(int x) +

Allows us to use a shorthand version for System.out.println(int x)

+ + + +void +println(long x) +

Allows us to use a shorthand version for System.out.println(long x)

+ + + +void +println(java.lang.Object o) +

Allows us to use a shorthand version for System.out.println(Object o)

+ + + +void +println(java.lang.String s) +

Allows us to use a shorthand version for System.out.println(String s)

+ + + boolean readBoolean(java.lang.String prompt) -

This method reads a boolean value from the user, asking them for either - a true or false value.

Allow the user to get a boolean.

- + double readDouble(java.lang.String prompt) -

This method reads a double value from the user, given a prompt.

Allow the user to get a double.

- + int readInt(java.lang.String prompt) -

This method reads a int value from the user, given a prompt.

Allow the user to get an integer.

- + java.lang.String readLine(java.lang.String prompt) -

This method reads a line of input from the user, given a prompt.

This is a dual purpose function.

- + void run() -

The run method is overwritten by the subclass.

This is a run method for the class.

+ + + +void +setInputs(java.lang.String[] inputStrings) +

Allows you to set all inputs at once as strings.

@@ -187,7 +351,7 @@

Method Summary

Methods inherited from class java.lang.Object

-equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait @@ -210,7 +374,8 @@

Constructor Detail

ConsoleProgram

public ConsoleProgram()

Constructor for Console program. Create a scanner instance to be used for user input.

Setups a new Scanner for System.in and the inputs variable for storring + inputs.

@@ -221,32 +386,61 @@

ConsoleProgram

Method Detail

- +

-
main
-
```
public static void main(java.lang.String[] args)
```
+
run
+
```
public void run()
```
+
This is a run method for the class. It is intentionally empty as it gets + overwritten by the subclass. + + All code to be run by a student or user should go in the overridden run + method.

- +

-
run
-
```
public void run()
```
-
The run method is overwritten by the subclass. This is the main entry point for - ConsolePrograms. There is no main method in student programs that extend ConsoleProgram, - instead they write their application starting like this: - - public void run() - { - // student code here - } - - The main method of ConsoleProgram calls this run method when it begins.
+
setInputs
+
```
public void setInputs(java.lang.String[] inputStrings)
```
+
Allows you to set all inputs at once as strings.
+
+
Parameters:
+
inputStrings - Array of strings to be inputs
+
+

+ + + +

+
addInput
+
```
public void addInput(java.lang.String s)
```
+
Allows you to add an input to your inputs.
+
+
Parameters:
+
s - String to add
+
+

+ + + +

+
main
+
```
public static void main(java.lang.String[] args)
```
+
ConsoleProgram can also be run as the main class. However this is not + necessary.
+
+
Parameters:
+
args - class name to run should be the first argument
+

@@ -256,12 +450,15 @@

run

readLine

public java.lang.String readLine(java.lang.String prompt)

This method reads a line of input from the user, given a prompt.

This is a dual purpose function. It both allows the user to get a + string input, as well as, get the next input for all other readers. + In all cases, it will return the next input as a string, either to the + user or another reader.

Parameters:: prompt - A prompt to the user to get input; prompt - String prompt to show user
Returns:: A String of the user input.; inputed string

@@ -272,13 +469,12 @@

readLine

readBoolean

public boolean readBoolean(java.lang.String prompt)

This method reads a boolean value from the user, asking them for either - a true or false value. This makes use of the readLine method.

Allow the user to get a boolean.

Parameters:: prompt - A prompt to the user to read a boolean value; prompt - String prompt to show user
Returns:: A boolean value read from the user.; inputed boolean

@@ -289,28 +485,300 @@

readBoolean

readDouble

public double readDouble(java.lang.String prompt)

This method reads a double value from the user, given a prompt.

Allow the user to get a double.

Parameters:: prompt - A prompt to the user to ask for a a double.; prompt - String prompt to show user
Returns:: A double value read from the user.; inputed double

readInt
```
public int readInt(java.lang.String prompt)
```
-
This method reads a int value from the user, given a prompt.
+
Allow the user to get an integer.

Parameters:
-
prompt - A prompt to the user to ask for an int
+
prompt - String prompt to show user

Returns:
-
The int value read from the user.
+
inputed integer
+
+

+ +

+
println
+
```
public void println()
```
+
Allows us to use a shorthand version for System.out.println()
+

+ +

+
println
+
```
public void println(java.lang.String s)
```
+
Allows us to use a shorthand version for System.out.println(String s)
+
+
Parameters:
+
s - String to print
+
+

+ +

+
println
+
```
public void println(boolean x)
```
+
Allows us to use a shorthand version for System.out.println(boolean x)
+
+
Parameters:
+
x - Boolean to print
+
+

+ +

+
println
+
```
public void println(char x)
```
+
Allows us to use a shorthand version for System.out.println(char x)
+
+
Parameters:
+
x - Character to print
+
+

+ +

+
println
+
```
public void println(char[] x)
```
+
Allows us to use a shorthand version for System.out.println(char[] x)
+
+
Parameters:
+
x - Character arry to print
+
+

+ +

+
println
+
```
public void println(int x)
```
+
Allows us to use a shorthand version for System.out.println(int x)
+
+
Parameters:
+
x - Integer to print
+
+

+ +

+
println
+
```
public void println(long x)
```
+
Allows us to use a shorthand version for System.out.println(long x)
+
+
Parameters:
+
x - Long to print
+
+

+ +

+
println
+
```
public void println(float x)
```
+
Allows us to use a shorthand version for System.out.println(float x)
+
+
Parameters:
+
x - Float to print
+
+

+ +

+
println
+
```
public void println(double x)
```
+
Allows us to use a shorthand version for System.out.println(double x)
+
+
Parameters:
+
x - Double to print
+
+

+ +

+
println
+
```
public void println(java.lang.Object o)
```
+
Allows us to use a shorthand version for System.out.println(Object o)
+
+
Parameters:
+
o - Object to print
+
+

+ +

+
print
+
```
public void print()
```
+
Allows us to use a shorthand version for System.out.print()
+

+ +

+
print
+
```
public void print(java.lang.String s)
```
+
Allows us to use a shorthand version for System.out.print(String s)
+
+
Parameters:
+
s - String to print with a new line
+
+

+ +

+
print
+
```
public void print(boolean x)
```
+
Allows us to use a shorthand version for System.out.print(boolean x)
+
+
Parameters:
+
x - Boolean to print with a new line
+
+

+ +

+
print
+
```
public void print(char x)
```
+
Allows us to use a shorthand version for System.out.print(char x)
+
+
Parameters:
+
x - Character to print with a new line
+
+

+ +

+
print
+
```
public void print(char[] x)
```
+
Allows us to use a shorthand version for System.out.print(char[] x)
+
+
Parameters:
+
x - Character arry to print with a new line
+
+

+ +

+
print
+
```
public void print(int x)
```
+
Allows us to use a shorthand version for System.out.print(int x)
+
+
Parameters:
+
x - Integer to print with a new line
+
+

+ +

+
print
+
```
public void print(long x)
```
+
Allows us to use a shorthand version for System.out.print(long x)
+
+
Parameters:
+
x - Long to print with a new line
+
+

+ +

+
print
+
```
public void print(float x)
```
+
Allows us to use a shorthand version for System.out.print(float x)
+
+
Parameters:
+
x - Float to print with a new line
+
+

+ +

+
print
+
```
public void print(double x)
```
+
Allows us to use a shorthand version for System.out.print(double x)
+
+
Parameters:
+
x - Double to print with a new line
+
+

+ +

+
print
+
```
public void print(java.lang.Object o)
```
+
Allows us to use a shorthand version for System.out.print(Object o)
+
+
Parameters:
+
o - Object to print with a new line

readInt

Prev Class
Next Class
Prev Class
Next Class

Frames

readInt

diff --git a/doc/Randomizer.html b/doc/Randomizer.html index c8162c3..d3efbda 100644 --- a/doc/Randomizer.html +++ b/doc/Randomizer.html @@ -2,28 +2,30 @@ - + Randomizer - +