minesweeper

Enum Images

java.lang.Object

java.lang.Enum<Images>

minesweeper.Images

All Implemented Interfaces:

Serializable, Comparable<Images>

public enum Images
extends Enum<Images>

Images is an enum that encodes 12 Minesweeper images.

Author:

2017-2018 APCS, David C. Petty

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLANK The enum associated with a blank square.
COVER The enum associated with a covered square.
FLAG The enum associated with a flagged square.
MINE The enum associated with a mined square.
NUMBER1 The enum associated with a square with 1 mine touching it.
NUMBER2 The enum associated with a square with 2 mines touching it.
NUMBER3 The enum associated with a square with 3 mines touching it.
NUMBER4 The enum associated with a square with 4 mines touching it.
NUMBER5 The enum associated with a square with 5 mines touching it.
NUMBER6 The enum associated with a square with 6 mines touching it.
NUMBER7 The enum associated with a square with 7 mines touching it.
NUMBER8 The enum associated with a square with 8 mines touching it.

Field Summary

Fields

Modifier and Type	Field and Description
private Image	image The Image to be displayed.
private String	path The pathname for Image to be displayed.

Method Summary

Modifier and Type	Method and Description
static Image	getImage(String path) Return Image associated with path.
Image	image() Return Image to be displayed.
String	path() Return pathname for Image to be displayed.
static Images	valueOf(String name) Returns the enum constant of this type with the specified name.
static Images[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COVER

public static final Images COVER

The enum associated with a covered square.

BLANK

public static final Images BLANK

The enum associated with a blank square.

FLAG

public static final Images FLAG

The enum associated with a flagged square.

MINE

public static final Images MINE

The enum associated with a mined square.

NUMBER1

public static final Images NUMBER1

The enum associated with a square with 1 mine touching it.

NUMBER2

public static final Images NUMBER2

The enum associated with a square with 2 mines touching it.

NUMBER3

public static final Images NUMBER3

The enum associated with a square with 3 mines touching it.

NUMBER4

public static final Images NUMBER4

The enum associated with a square with 4 mines touching it.

NUMBER5

public static final Images NUMBER5

The enum associated with a square with 5 mines touching it.

NUMBER6

public static final Images NUMBER6

The enum associated with a square with 6 mines touching it.

NUMBER7

public static final Images NUMBER7

The enum associated with a square with 7 mines touching it.

NUMBER8

public static final Images NUMBER8

The enum associated with a square with 8 mines touching it.

Field Detail

path

private final String path

The pathname for Image to be displayed.

image

private final Image image

The Image to be displayed.

Method Detail

values

public static Images[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Images c : Images.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Images valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

path

public String path()

Return pathname for Image to be displayed.

Returns:

pathname for Image to be displayed

image

public Image image()

Return Image to be displayed.

Returns:

Image to be displayed

getImage

public static Image getImage(String path)

Return Image associated with path.

Parameters:

path - pathname for Image

Returns:

Image associated with path

Precondition:

path is not null, path is a valid pathname for an image file