Package org.refcodes.data.ext.symbols

Enum SymbolPixmap

java.lang.Object

java.lang.Enum<SymbolPixmap>

org.refcodes.data.ext.symbols.SymbolPixmap

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SymbolPixmap>, org.refcodes.data.DataLocator

public enum SymbolPixmap
extends java.lang.Enum<SymbolPixmap>
implements org.refcodes.data.DataLocator

The SymbolPixmap defines the pixmaps which can be retrieved by the according SymbolPixmapUrlFactory and SymbolPixmapInputStreamFactory.

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, org.refcodes.data.DataLocator.DataLocatorPropertyBuilder

Enum Constant Summary

Enum Constants

Enum Constant	Description
SKULL

Method Summary

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

SKULL

public static final SymbolPixmap SKULL

Method Detail

values

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

Returns:

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

valueOf

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

getDataUrl

public java.net.URL getDataUrl()

Specified by:

getDataUrl in interface org.refcodes.data.DataLocator

getDataInputStream

public java.io.InputStream getDataInputStream()

Specified by:

getDataInputStream in interface org.refcodes.data.DataLocator

fromName

public static SymbolPixmap fromName(java.lang.String aPixmapName)

Retrieves the enumeration element representing the given pixmap 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.