Die

java.lang.Object
- cse1030.Die

All Implemented Interfaces:

Comparable<Die>
```
public class Die
extends Object
implements Comparable<Die>
```
A class that represents a fair die having at least two faces. The number of faces can be set at construction but are fixed thereafter. The faces are numbered starting from 1 in increments of 1 for each additional face.

Author:

Burton Ma

Constructor Summary

Constructors
Constructor and Description
`Die()` Create a six sided die and sets its face value to a random value between `1` and `6`, inclusive.
`Die(Die d)` Create a die that has the same number of faces and same value as another die.
`Die(int faces)` Create a die with the specified number of faces and sets its face value to a random value between `1` and `faces`, inclusive.
`Die(int faces, int value)` Create a die with the specified number of faces and sets its face value to a specified value.
`Die(int faces, Random rng)` Create a die with the specified number of faces and a specified random number generator, and sets its face value to a random value between `1` and `faces`, inclusive.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(Die other)` Compares two dice by their face value.
`boolean`	`equals(Object obj)` Compares two dice for equality.
`int`	`getFaces()` Get the number of faces of the die.
`int`	`getValue()` Get the current face value of the die.
`int`	`hashCode()` Returns a hash code for this object.
`void`	`roll()` Roll the die to a new random face value.
`String`	`toString()` Returns a string representation of this die, which includes the number of faces and the current face value.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Die
```
public Die()
```
    Create a six sided die and sets its face value to a random value between 1 and 6, inclusive.
  - Die
```
public Die(int faces)
```
    Create a die with the specified number of faces and sets its face value to a random value between 1 and faces, inclusive. The number of faces must be greater than or equal to 2.
    
    Throws:
    
    IllegalArgumentException - if faces < 2.
    Parameters:
    faces - The number of faces.
    Precondition
    
    faces >= 2
  - Die
```
public Die(int faces,
   int value)
```
    Create a die with the specified number of faces and sets its face value to a specified value.
    
    Throws:
    
    IllegalArgumentException - if faces < 2 or (value < 1 || value > faces)
    Parameters:
    faces - The number of faces.
    value - The initial face value.
    Precondition
    
    0 > value && value <= faces
  - Die
```
public Die(Die d)
```
    Create a die that has the same number of faces and same value as another die.
    The created die is independent of the copied die; i.e., rolling the copied die will produce a different sequence of rolls than rolling the original die.
    
    Parameters:
    d - the die to copy
  - Die
```
public Die(int faces,
   Random rng)
```
    Create a die with the specified number of faces and a specified random number generator, and sets its face value to a random value between 1 and faces, inclusive. The number of faces must be greater than or equal to 2.
    
    Throws:
    
    IllegalArgumentException - if faces < 2
    Parameters:
    faces -
    rng -
    Precondition
    
    faces >= 2
- Method Detail
  - getValue
```
public int getValue()
```
    Get the current face value of the die.
    
    Returns:
    The current face value of the die.
  - getFaces
```
public int getFaces()
```
    Get the number of faces of the die.
    
    Returns:
    The number of faces of the die.
  - roll
```
public void roll()
```
    Roll the die to a new random face value.
  - compareTo
```
public int compareTo(Die other)
```
    Compares two dice by their face value. The result is negative if this Die has a current face value less than the argument die. The result is positive if this Die has a current face value greater than the argument die. The result is zero if both dice have the same current face value.
    
    Specified by:
    
    compareTo in interface Comparable<Die>
    
    Parameters:
    the - Die to be compared.
  - toString
```
public String toString()
```
    Returns a string representation of this die, which includes the number of faces and the current face value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this die.
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this object. The hash code is computed using the number of faces and the current face value.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    a hash code value for this object.
  - equals
```
public boolean equals(Object obj)
```
    Compares two dice for equality. Two dice are equal if their current face values are equal.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj - the object to compare with.
    
    Returns:
    true if the face values are the same; false otherwise.

Class Die

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Die

Die

Die

Die

Die

Method Detail

getValue

getFaces

roll

compareTo

toString

hashCode

equals