dev.roanh.picross

Enum Tile

java.lang.Object

java.lang.Enum<Tile>

dev.roanh.picross.Tile

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Tile>

public enum Tile
extends java.lang.Enum<Tile>

Enum of different Tile states.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CROSS Indicates a 'cross' tile.
EMPTY Indicates an empty tile.
FILL Indicates a 'filled' tile.
SEL_CROSS Indicates an area selection tile that will transition towards the CROSS state.
SEL_EMPTY Indicates an area selection tile that will transition towards the EMPTY state.
SEL_FILL Indicates an area selection tile that will transition towards the FILL state.
SEL_TRY_CROSS Indicates an area selection tile that will transition towards the TRY_CROSS state.
SEL_TRY_FILL Indicates an area selection tile that will transition towards the TRY_FILL state.
TRY_CROSS Indicates a test mode 'cross' tile.
TRY_FILL Indicates a test mode 'filled' tile.

Method Summary

Modifier and Type	Method and Description
boolean	canOverride(Tile replacement, boolean testMode, Tile base) Check to see if the given tile can replace this tile.
boolean	isReal() Returns if this tile is a non test mode tile.
boolean	isTest() Returns if this tile is a test mode tile or not.
Tile	toReal() Converts this tile to it's non-test mode equivalent tile.
Tile	toSelection() Gets the area selection variant of this tile.
Tile	toTest() Converts this tile to it's test mode equivalent tile.
static Tile	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Tile[]	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

EMPTY

public static final Tile EMPTY

Indicates an empty tile.

CROSS

public static final Tile CROSS

Indicates a 'cross' tile.

FILL

public static final Tile FILL

Indicates a 'filled' tile.

TRY_CROSS

public static final Tile TRY_CROSS

Indicates a test mode 'cross' tile.

TRY_FILL

public static final Tile TRY_FILL

Indicates a test mode 'filled' tile.

SEL_EMPTY

public static final Tile SEL_EMPTY

Indicates an area selection tile that will transition towards the EMPTY state.

SEL_CROSS

public static final Tile SEL_CROSS

Indicates an area selection tile that will transition towards the CROSS state.

SEL_FILL

public static final Tile SEL_FILL

Indicates an area selection tile that will transition towards the FILL state.

SEL_TRY_CROSS

public static final Tile SEL_TRY_CROSS

Indicates an area selection tile that will transition towards the TRY_CROSS state.

SEL_TRY_FILL

public static final Tile SEL_TRY_FILL

Indicates an area selection tile that will transition towards the TRY_FILL state.

Method Detail

values

public static Tile[] 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 (Tile c : Tile.values())
    System.out.println(c);

Returns:

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

valueOf

public static Tile valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

toSelection

public Tile toSelection()

Gets the area selection variant of this tile.

Returns:

The area selection variant of this tile.

toReal

public Tile toReal()

Converts this tile to it's non-test mode equivalent tile. Returns this tile itself if this tile is not a test mode tile.

Returns:

The non-test mode version of this tile.

toTest

public Tile toTest()

Converts this tile to it's test mode equivalent tile. Returns this tile itself if this tile is already a test mode tile.

Returns:

The non-test mode version of this tile.

isTest

public boolean isTest()

Returns if this tile is a test mode tile or not.

Returns:

True if this tile is a test mode tile, false if it is not.

isReal

public boolean isReal()

Returns if this tile is a non test mode tile.

Returns:

True if this tile is not a test mode tile.

canOverride

public boolean canOverride(Tile replacement,
                           boolean testMode,
                           Tile base)

Check to see if the given tile can replace this tile.

Parameters:

replacement - The replacement tile.

testMode - Whether test mode is enabled or not.

base - The type of the tile was initially clicked.

Returns:

True if the given replacement tile can override this tile.