TicTacToeMyHashMap

java.lang.Object
- TicTacToeMyHashMap

```
public class TicTacToeMyHashMap
extends java.lang.Object
```
TicTacToeMyHashMap is a class to store winning TicTacToe Strings in a HashMap with TTTHashString keys and boolean values. The class fills a hash map with the Strings than analyzes the map for aspects like capacity, load factor, and distribution. This class will mainly be used to analyze the efficiency of a hash map with my hashCode method as compared to Java's hash code in the storage of TicTacToe strings. Additionally, this class uses reflection in order to analyze the hash map considering the array in which the values are stored is not easily accessible, and HashMap.Entry, which is the type of array is not a public Java class. Additionally, this class has the nested class of TTTHashString. This class was created in order for the hash map to use my overridden hashCode method in tttHashString rather than Java's. For almost all intents and purpose, it is basically a String class that has an overridden hash code and needs to be created with a specific hash map capacity, in order for the hashCode method to be effective. Note: Matthew Grillo basically made this class possible through his thorough research on the subject. All adulation directed toward this class would be misdirected unless 80% was directed towards him. This is the same comment as the one included in TicTacToeHashMap's Javadocs Also, the capacity() method was mainly written by Mrs. Kelly.

Author:

AnneMarie Caballero (annemariecabs)

Nested Class Summary

Nested Classes
Modifier and Type Class Description

private class TicTacToeMyHashMap.TTTHashString
A nested class within TicTacToeMyHashMap.

Nested Classes
Modifier and Type	Class	Description
`private class`	`TicTacToeMyHashMap.TTTHashString`	A nested class within TicTacToeMyHashMap.

Field Summary

Fields
Modifier and Type	Field	Description
`private static int`	`ERROR_CODE`	An integer constant holding the number (1) that is passed to System.exit() after certain conditions occur
`private static int`	`HASHMAP_SIZE`	The size of the HashMap chosen because it is one of the closest powers of two (specifically it's 2^9) to a load factor of two (and I would prefer the smaller one out of the two options)
`private static int`	`NUMBER_OF_WINNERS`	The number of winning TicTacToe Strings
`private static java.lang.String`	`WINNER_FILE`	The name of the file with the TicTacToe winners
`private static java.lang.String`	`WINNER_FILE_NOT_FOUND`	The error message used if the file with the winners is not found
`(package private) java.util.HashMap<TicTacToeMyHashMap.TTTHashString,java.lang.Boolean>`	`winners`	The HashMap that holds the winning TicTacToe Strings.

Constructor Summary

Constructors
Constructor Description

TicTacToeMyHashMap()
Constructs a TicTacToeMyHashMap, which holds a HashMap with TTTHashString key and a Boolean value.

Constructors
Constructor	Description
`TicTacToeMyHashMap()`	Constructs a TicTacToeMyHashMap, which holds a HashMap with TTTHashString key and a Boolean value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private int`	`capacity()`	Uses reflection to return the capacity of the winners HashMap
`private java.lang.Object`	`getNext(java.util.Map.Entry entry)`	Uses reflection to return the next node after a HashMap.Entry in a linked list
`private java.util.Map.Entry[]`	`getTable()`	Uses reflection to return the table of the winners HashMap, which is a HashMap.Entry[]
`private boolean`	`hasNext(java.util.Map.Entry entry)`	Uses reflection whether a HashMap.Entry in a linked list has a next node
`static void`	`main(java.lang.String[] args)`

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

- Field Detail
  - winners
```
java.util.HashMap<TicTacToeMyHashMap.TTTHashString,java.lang.Boolean> winners
```
    The HashMap that holds the winning TicTacToe Strings. The key is a TTTHashString and its boolean value, which should just be true for the filled in Strings, is stored in the HashMap. TTTHashString is used in this method because its hashCode has been overridden by myself.
  - NUMBER_OF_WINNERS
```
private static final int NUMBER_OF_WINNERS
```
    The number of winning TicTacToe Strings
    
    See Also:
    
    Constant Field Values
  - HASHMAP_SIZE
```
private static final int HASHMAP_SIZE
```
    The size of the HashMap chosen because it is one of the closest powers of two (specifically it's 2^9) to a load factor of two (and I would prefer the smaller one out of the two options)
    
    See Also:
    
    Constant Field Values
  - ERROR_CODE
```
private static final int ERROR_CODE
```
    An integer constant holding the number (1) that is passed to System.exit() after certain conditions occur
    
    See Also:
    
    Constant Field Values
  - WINNER_FILE
```
private static final java.lang.String WINNER_FILE
```
    The name of the file with the TicTacToe winners
    
    See Also:
    
    Constant Field Values
  - WINNER_FILE_NOT_FOUND
```
private static final java.lang.String WINNER_FILE_NOT_FOUND
```
    The error message used if the file with the winners is not found
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TicTacToeMyHashMap
```
TicTacToeMyHashMap()
```
    Constructs a TicTacToeMyHashMap, which holds a HashMap with TTTHashString key and a Boolean value. The method also initializes the HashMap using all possible winning TicTacToe Strings. The HashMap capacity is set specifically to HASHMAP_SIZE and the load factor is set so that it would not be automatically resized. This method uses my hashCode method written below in the special TTTHashString method.
- Method Detail
  - capacity
```
private int capacity()
              throws java.lang.NoSuchFieldException,
                     java.lang.IllegalAccessException
```
    Uses reflection to return the capacity of the winners HashMap
    
    Returns:
    
    the capacity of the winners HashMap
    
    Throws:
    
    java.lang.NoSuchFieldException - thrown if the reflective field this method is looking for, which is table, cannot be found
    
    java.lang.IllegalAccessException - thrown when the method tries to use reflection without access
  - getTable
```
private java.util.Map.Entry[] getTable()
                                throws java.lang.NoSuchFieldException,
                                       java.lang.IllegalAccessException
```
    Uses reflection to return the table of the winners HashMap, which is a HashMap.Entry[]
    
    Returns:
    
    a HashMap.Entry[] that represents the table in a HashMap
    
    Throws:
    
    java.lang.NoSuchFieldException - thrown if the reflective field this method is looking for, which is table, cannot be found
    
    java.lang.IllegalAccessException - thrown when the method tries to use reflection without access
  - getNext
```
private java.lang.Object getNext(java.util.Map.Entry entry)
                          throws java.lang.NoSuchFieldException,
                                 java.lang.IllegalAccessException
```
    Uses reflection to return the next node after a HashMap.Entry in a linked list
    
    Parameters:
    
    entry - a HashMap.Entry for which the next node will be found
    
    Returns:
    
    the next node after a HashMap.Entry
    
    Throws:
    
    java.lang.NoSuchFieldException - thrown if the reflective field this method is looking for, which is next, cannot be found
    
    java.lang.IllegalAccessException - thrown when the method tries to use reflection without access
  - hasNext
```
private boolean hasNext(java.util.Map.Entry entry)
                 throws java.lang.NoSuchFieldException,
                        java.lang.IllegalAccessException
```
    Uses reflection whether a HashMap.Entry in a linked list has a next node
    
    Parameters:
    
    entry - a HashMap.Entry for which it will be assessed if it has a next node
    
    Returns:
    
    if entry has a node after it
    
    Throws:
    
    java.lang.NoSuchFieldException - thrown if the reflective field this method is looking for, which is next, cannot be found
    
    java.lang.IllegalAccessException - thrown when the method tries to use reflection without access
  - main
```
public static void main(java.lang.String[] args)
                 throws java.io.FileNotFoundException,
                        java.lang.NoSuchFieldException,
                        java.lang.IllegalAccessException
```
    Throws:
    
    java.io.FileNotFoundException
    
    java.lang.NoSuchFieldException
    
    java.lang.IllegalAccessException

Class TicTacToeMyHashMap

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

winners

NUMBER_OF_WINNERS

HASHMAP_SIZE

ERROR_CODE

WINNER_FILE

WINNER_FILE_NOT_FOUND

Constructor Detail

TicTacToeMyHashMap

Method Detail

capacity

getTable

getNext

hasNext

main