TicTacToe

java.lang.Object
- TicTacToe

```
public class TicTacToe
extends java.lang.Object
```
This class holds all of the necessary methods needed for TicTacToes. This includes multiple versions of methods such as isWin that take in different parameters, namely the two forms the TicTacToe is stored in (a nine-character String and a 2D 3 by 3 char array). Other important methods allow counting the number of chars in a board, checking if a board is valid, converting boards between the two forms and many other options. This class was created by my instructor to aid in the Hash Functions assignment. Then, the main creates a String, and prints if it is valid, if it has a row win, a column win, or a diagonal win and if it is a win.

Author:

Mrs. Kelly

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`CHAR_POSSIBILITIES`	An integer constant holding the number of possibilities for the chars used which is three because the only eligible chars for TicTacToe are x, o and space
`static int`	`COLS`	An integer constant holding the number of cols: 3
`static int`	`POSSIBILITIES`	An integer constant holding the number of possibilities for TicTacToe boards which is three to the ninth
`static int`	`ROWS`	An integer constant holding the number of rows: 3

Constructor Summary

Constructors
Constructor Description

TicTacToe()

Constructors
Constructor	Description
`TicTacToe()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`private static java.lang.String`	`addOne(java.lang.String s)`	Adds one to the last char of the String and adjust all of the other chars appropriately
`static java.lang.String`	`boardToString(char[][] b)`	Converts a TicTacToe board into a String
`private static boolean`	`colWin(char[][] board)`	Returns whether or not the board has a column win on it
`private static boolean`	`diagonalWin(char[][] board)`	Returns whether or not the board has a diagonal win on it
`static java.lang.String[]`	`fillValues()`	Returns a String array with all the possible values for a TicTacToe board.
`static boolean`	`isWin(char[][] b)`	Returns whether the passed in board is a win by checking if the board is valid and if there is a row win, a col win or a diagonal win.
`static boolean`	`isWin(java.lang.String s)`	Returns whether a String is a win, by converting s to a board and then checking the board produced using isWin.
`static java.lang.String`	`isWinString(char[][] b)`	Performs the same function as isWin but instead of returning a boolean, it returns a String which allows the type of win to be returned.
`static java.lang.String`	`isWinString(java.lang.String s)`	Returns whether what type of win a String is, by converting s to a board and then checking the board produced using isWinString.
`static void`	`main(java.lang.String[] args)`
`static char[][]`	`makeBoard(java.lang.String s)`	Makes and returns a board when sent a String
`static int`	`numChars(char[][] b, char ch)`	Returns the number of the specified char on the board
`private static boolean`	`rowWin(char[][] board)`	Returns whether or not the board has a row win on it
`static char[][]`	`stringToBoard(java.lang.String board)`	Converts a TicTacToe String into a board, which is a 3 by 3 char array
`static boolean`	`valid(char[][] board)`	Checks if the board is valid.
`static char`	`whichLetter(char ch)`	Returns which letter the numerical equivalent (that this program uses) of the chars are

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ROWS
```
public static final int ROWS
```
    An integer constant holding the number of rows: 3
    
    See Also:
    
    Constant Field Values
  - COLS
```
public static final int COLS
```
    An integer constant holding the number of cols: 3
    
    See Also:
    
    Constant Field Values
  - POSSIBILITIES
```
public static final int POSSIBILITIES
```
    An integer constant holding the number of possibilities for TicTacToe boards which is three to the ninth
  - CHAR_POSSIBILITIES
```
public static final int CHAR_POSSIBILITIES
```
    An integer constant holding the number of possibilities for the chars used which is three because the only eligible chars for TicTacToe are x, o and space
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TicTacToe
```
public TicTacToe()
```
- Method Detail
  - numChars
```
public static int numChars(char[][] b,
                           char ch)
```
    Returns the number of the specified char on the board
    
    Parameters:
    
    b - a 2d char array representing a TicTacToe board
    
    ch - the char to be counted
    
    Returns:
    
    the number of times ch appears on b
  - valid
```
public static boolean valid(char[][] board)
```
    Checks if the board is valid. For example, boards with less than 3 xs or 3 os are not considered valid boards.
    
    Parameters:
    
    board - the TicTacToe board to be checked
    
    Returns:
    
    true, if board is valid; false, otherwise
  - boardToString
```
public static java.lang.String boardToString(char[][] b)
```
    Converts a TicTacToe board into a String
    
    Parameters:
    
    b - the board to be converted
    
    Returns:
    
    the String form of b
  - stringToBoard
```
public static char[][] stringToBoard(java.lang.String board)
```
    Converts a TicTacToe String into a board, which is a 3 by 3 char array
    
    Parameters:
    
    board - the String to be converted
    
    Returns:
    
    the char array form of String
  - whichLetter
```
public static char whichLetter(char ch)
```
    Returns which letter the numerical equivalent (that this program uses) of the chars are
    
    Parameters:
    
    ch - the char for whose numerical equivalent should be returned
    
    Returns:
    
    'x' if ch is 1, '2' if ch is o, ' ' if ch is 1, else returns ch
  - makeBoard
```
public static char[][] makeBoard(java.lang.String s)
```
    Makes and returns a board when sent a String
    
    Parameters:
    
    s - the String to be converted to a board
    
    Returns:
    
    a 2d array of chars representing the String as a board
  - addOne
```
private static java.lang.String addOne(java.lang.String s)
```
    Adds one to the last char of the String and adjust all of the other chars appropriately
    
    Parameters:
    
    s - a 9 character char composed of 0s, 1s and 2s
    
    Returns:
    
    the String version of s with one added
  - fillValues
```
public static java.lang.String[] fillValues()
```
    Returns a String array with all the possible values for a TicTacToe board. This uses the addOne method in a while array to do so.
    
    Returns:
    
    a String array with the possible values for a TicTacToe Board (of size 3^9)
  - diagonalWin
```
private static boolean diagonalWin(char[][] board)
```
    Returns whether or not the board has a diagonal win on it
    
    Parameters:
    
    board - the board to be checked, which is a 2D char array
    
    Returns:
    
    true, if the board has a diagonal win, false otherwise
  - rowWin
```
private static boolean rowWin(char[][] board)
```
    Returns whether or not the board has a row win on it
    
    Parameters:
    
    board - the board to be checked, which is a 2D char array
    
    Returns:
    
    true, if the board has a row win, false otherwise
  - colWin
```
private static boolean colWin(char[][] board)
```
    Returns whether or not the board has a column win on it
    
    Parameters:
    
    board - the board to be checked, which is a 2D char array
    
    Returns:
    
    true, if the board has a column win, false otherwise
  - isWin
```
public static boolean isWin(char[][] b)
```
    Returns whether the passed in board is a win by checking if the board is valid and if there is a row win, a col win or a diagonal win.
    
    Parameters:
    
    b - the board to be checked
    
    Returns:
    
    true, if the board is valid and has a win, false otherwise
  - isWinString
```
public static java.lang.String isWinString(char[][] b)
```
    Performs the same function as isWin but instead of returning a boolean, it returns a String which allows the type of win to be returned.
    
    Parameters:
    
    b - the board as a 2D char array
    
    Returns:
    
    the type of win as a String
  - isWin
```
public static boolean isWin(java.lang.String s)
```
    Returns whether a String is a win, by converting s to a board and then checking the board produced using isWin.
    
    Parameters:
    
    s - the String to be checked for a win
    
    Returns:
    
    true, if s is a win, false otherwise
  - isWinString
```
public static java.lang.String isWinString(java.lang.String s)
```
    Returns whether what type of win a String is, by converting s to a board and then checking the board produced using isWinString.
    
    Parameters:
    
    s - the String to be checked for a win
    
    Returns:
    
    the type of win as a String
  - main
```
public static void main(java.lang.String[] args)
```

Class TicTacToe

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ROWS

COLS

POSSIBILITIES

CHAR_POSSIBILITIES

Constructor Detail

TicTacToe

Method Detail

numChars

valid

boardToString

stringToBoard

whichLetter

makeBoard

addOne

fillValues

diagonalWin

rowWin

colWin

isWin

isWinString

isWin

isWinString

main