Module org.refcodes.data.ext.checkers

Package org.refcodes.data.ext.checkers

Enum CheckerVectorGraphics

java.lang.Object

java.lang.Enum<CheckerVectorGraphics>

org.refcodes.data.ext.checkers.CheckerVectorGraphics

All Implemented Interfaces:

Serializable, Comparable<CheckerVectorGraphics>, org.refcodes.data.DataLocator

public enum CheckerVectorGraphics
extends Enum<CheckerVectorGraphics>
implements org.refcodes.data.DataLocator

The CheckerVectorGraphics defines the pixmaps which can be retrieved by the according CheckerVectorGraphicsUrlFactory and CheckerVectorGraphicsInputStreamFactory.

Author:

steiner

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.data.DataLocator

org.refcodes.data.DataLocator.DataLocatorBuilder<B extends org.refcodes.data.DataLocator.DataLocatorBuilder<B>>, org.refcodes.data.DataLocator.DataLocatorMutator, org.refcodes.data.DataLocator.DataLocatorProperty

Enum Constant Summary

Enum Constants

Enum Constant	Description
FXML_PIECE_GRAY
FXML_PIECE_RED
FXML_PIECE_WHITE
SVG_PIECE_GRAY
SVG_PIECE_RED
SVG_PIECE_WHITE

Method Summary

Modifier and Type	Method	Description
static CheckerVectorGraphics	fromName(String aPixmapName)	Retrieves the enumeration element representing the given vector graphics name (ignoring the case) or null if none was found.
InputStream	getDataInputStream()
URL	getDataUrl()
static CheckerVectorGraphics	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CheckerVectorGraphics[]	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

SVG_PIECE_GRAY

public static final CheckerVectorGraphics SVG_PIECE_GRAY

FXML_PIECE_GRAY

public static final CheckerVectorGraphics FXML_PIECE_GRAY

SVG_PIECE_RED

public static final CheckerVectorGraphics SVG_PIECE_RED

FXML_PIECE_RED

public static final CheckerVectorGraphics FXML_PIECE_RED

SVG_PIECE_WHITE

public static final CheckerVectorGraphics SVG_PIECE_WHITE

FXML_PIECE_WHITE

public static final CheckerVectorGraphics FXML_PIECE_WHITE

Method Detail

values

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

Returns:

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

valueOf

public static CheckerVectorGraphics 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

getDataUrl

public URL getDataUrl()

Specified by:

getDataUrl in interface org.refcodes.data.DataLocator

getDataInputStream

public InputStream getDataInputStream()

Specified by:

getDataInputStream in interface org.refcodes.data.DataLocator

fromName

public static CheckerVectorGraphics fromName(String aPixmapName)

Retrieves the enumeration element representing the given vector graphics name (ignoring the case) or null if none was found.

Parameters:

aPixmapName - The pixmap name for which to get the enumeration element.

Returns:

The enumeration element determined or null if none matching was found.