cse1030.test1

Class Rps

java.lang.Object

cse1030.test1.Rps

public final class Rps
extends Object

An immutable class that represents hands of the game rock-paper-scissors.

Author:

CSE1030_F13_14

Field Summary

Fields

Modifier and Type	Field and Description
static String	PAPER The string representing paper.
static String	ROCK The string representing rock.
static String	SCISSORS The string representing scissors.

Constructor Summary

Constructors

Constructor and Description
Rps() Construct a hand representing rock.
Rps(Rps other) Construct a hand that is a copy of the other hand.
Rps(String value) Construct a hand representing the given string.

Method Summary

Methods

Modifier and Type	Method and Description
int	compare(Rps other) Compares this hand to some other hand.
static Rps	defeats(Rps other) Returns the hand that defeats the given hand.
boolean	equals(Object obj) Compares this hand to the specified object.
String	getValue() Returns the string representing this hand.
String	toString() Returns the string representing this hand followed by an exclamation mark.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ROCK

public static final String ROCK

The string representing rock.

See Also:

Constant Field Values

PAPER

public static final String PAPER

The string representing paper.

See Also:

Constant Field Values

SCISSORS

public static final String SCISSORS

The string representing scissors.

See Also:

Constant Field Values

Constructor Detail

Rps

public Rps()

Construct a hand representing rock.

Rps

public Rps(String value)

Construct a hand representing the given string.

Throws:

IllegalArgumentException - if value is not one of the strings Rps.ROCK, Rps.PAPER, Rps.SCISSORS

Parameters:

value - the kind of hand

Rps

public Rps(Rps other)

Construct a hand that is a copy of the other hand.

Parameters:

other - the hand to copy

Method Detail

getValue

public String getValue()

Returns the string representing this hand. The returned string will always be equals to one of Rps.ROCK, Rps.PAPER, Rps.SCISSORS

Returns:

the string representing this hand

compare

public int compare(Rps other)

Compares this hand to some other hand. Returns 1 if this hand beats the other hand; returns 0 if this hand equals the other hand; and returns -1 if this hand loses to the other hand.

Parameters:

other - the hand to compare

Returns:

1 if this hand beats the other hand; 0 if this hand equals the other hand; -1 if this hand loses to the other hand.

toString

public String toString()

Returns the string representing this hand followed by an exclamation mark. The returned string will always be equals to one of Rps.ROCK, Rps.PAPER, Rps.SCISSORS followed by an exclamation mark.

Overrides:

toString in class Object

See Also:

Object.toString()

Returns:

the string representing this hand.

equals

public boolean equals(Object obj)

Compares this hand to the specified object. The result is true if and only if the argument is not null and is a Rps object that represents the same hand as this object.

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

Parameters:

obj - the object to compare this hand against

Returns:

true if the given object represents a Rps object equivalent to this hand; false otherwise

defeats

public static Rps defeats(Rps other)

Returns the hand that defeats the given hand. For example:

Rps hand = Rps.defeats(new Rps("rock"));

would return the hand whose value is "paper".

Parameters:

other - the hand to beat

Returns:

the hand that beats other