Class Piece

java.lang.Object

Piece

Direct Known Subclasses:

LRPiece, LRUDPiece, UDPiece

public abstract class Piece
extends java.lang.Object

Piece - An abstract class for a Railroad Rush Hour puzzle piece

Field Summary

Fields

Modifier and Type	Field and Description
protected char[][]	board character representation of board
protected char	displayChar character representing piece
protected int	leftCol piece leftmost column
protected int	size piece dimension
protected int	topRow piece topmost row

Constructor Summary

Constructors

Constructor and Description
Piece(char[][] board, char displayChar, int size, int topRow, int leftCol)

Method Summary

Modifier and Type	Method and Description
boolean	canMoveDir(Direction dir) Return whether or not the piece is, in general, permitted to move in the given direction.
abstract int	getBottomRow() Return the row of the piece's bottom right corner.
int	getLeftCol() Return the leftmost column of the piece.
abstract int	getRightCol() Return the column of the piece's bottom right corner.
int	getTopRow() Return the top row of the piece.
java.lang.String	toString() Return a String with the single display character for the piece.
boolean	tryMove(Direction dir) Attempt a piece movement in a given direction, returning true or false depending on whether or not the move was successful.

Methods inherited from class java.lang.Object

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

Field Detail

board

protected char[][] board

character representation of board

displayChar

protected char displayChar

character representing piece

size

protected int size

piece dimension

topRow

protected int topRow

piece topmost row

leftCol

protected int leftCol

piece leftmost column

Constructor Detail

Piece

public Piece(char[][] board,
             char displayChar,
             int size,
             int topRow,
             int leftCol)

Parameters:

board - a reference to the RandomRailroadRushHour char[][] board object common to all pieces

displayChar - the character used to "paint" the piece on the board representation

size - the size of the piece. For up/down- or left/right-moving train pieces (with width 1), this is the piece length in grid squares. For left/right/up/down-moving platform pieces, this is the size length in grid squares.

topRow - the row of the piece's top left corner

leftCol - the column of the piece's top left corner

Method Detail

getTopRow

public int getTopRow()

Return the top row of the piece.

Returns:

the top row of the piece

getLeftCol

public int getLeftCol()

Return the leftmost column of the piece.

Returns:

the leftmost column of the piece

toString

public java.lang.String toString()

Return a String with the single display character for the piece.

Overrides:

toString in class java.lang.Object

Returns:

a String with the single display character for the piece

See Also:

Object.toString()

tryMove

public boolean tryMove(Direction dir)

Attempt a piece movement in a given direction, returning true or false depending on whether or not the move was successful.

Parameters:

dir - given direction of attempted movement

Returns:

whether or not the given move was successful

getBottomRow

public abstract int getBottomRow()

Return the row of the piece's bottom right corner.

Returns:

the row of the piece's bottom right corner

getRightCol

public abstract int getRightCol()

Return the column of the piece's bottom right corner.

Returns:

the column of the piece's bottom right corner

canMoveDir

public boolean canMoveDir(Direction dir)

Return whether or not the piece is, in general, permitted to move in the given direction. Note that this method should be _overridden_ for some piece types.

Parameters:

dir - given direction of movement

Returns:

whether or not the piece is, in general, permitted to move in the given direction.