Package me.hackware.api.util

Enum Class TextIcons.Icon

java.lang.Object

java.lang.Enum<TextIcons.Icon>

me.hackware.api.util.TextIcons.Icon

All Implemented Interfaces:

Serializable, Comparable<TextIcons.Icon>, Constable

Enclosing class:

TextIcons

public static enum TextIcons.Icon
extends Enum<TextIcons.Icon>

The available icon glyphs. Codepoints run contiguously from INFO, and the order must match IconGlyphProvider.ICONS.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ERROR	Filled circle with an exclamation — failures and bad usage.
INFO	Filled info circle — informational messages.
LAN	LAN icon — local area network (chat prefix, connection notices).
SKULL	Skull — death notifications only.
WARNING	Warning triangle — warnings, errors, usage hints.

Method Summary

Modifier and Type	Method	Description
char	glyph()
String	toString()	The glyph itself, so an icon drops straight into a concatenated message.
static TextIcons.Icon	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TextIcons.Icon[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INFO

public static final TextIcons.Icon INFO

Filled info circle — informational messages.

WARNING

public static final TextIcons.Icon WARNING

Warning triangle — warnings, errors, usage hints.

SKULL

public static final TextIcons.Icon SKULL

Skull — death notifications only. Logouts and disconnects use WARNING.

ERROR

public static final TextIcons.Icon ERROR

Filled circle with an exclamation — failures and bad usage.

LAN

public static final TextIcons.Icon LAN

LAN icon — local area network (chat prefix, connection notices).

Method Details

values

public static TextIcons.Icon[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static TextIcons.Icon valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

glyph

public char glyph()

toString

public String toString()

The glyph itself, so an icon drops straight into a concatenated message.

Overrides:

toString in class Enum<TextIcons.Icon>