Package com.atlassian.confluence.content.render.xhtml.model.inline

Enum Emoticon

java.lang.Object

java.lang.Enum<Emoticon>

com.atlassian.confluence.content.render.xhtml.model.inline.Emoticon

All Implemented Interfaces:

Serializable, Comparable<Emoticon>

public enum Emoticon
extends Enum<Emoticon>

Emoticons are represented explicitly in Confluence storage format. This class is the in memory representation of an emoticon.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLUE_STAR
BROKEN_HEART
CHEEKY
CROSS
GREEN_STAR
HEART
INFORMATION
LAUGH
LIGHT_OFF
LIGHT_ON
MINUS
PLUS
QUESTION
RED_STAR
SAD
SMILE
THUMBS_DOWN
THUMBS_UP
TICK
WARNING
WINK
YELLOW_STAR

Field Summary

Fields

Modifier and Type	Field	Description
static String	IDENTIFYING_ATTRIBUTE_NAME	Used to identify UI elements as being emoticons.

Method Summary

Modifier and Type	Method	Description
static Emoticon	get(String type)
String	getType()
boolean	isSecret()
static Emoticon[]	notSecretValues()
static Emoticon	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Emoticon[]	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

SMILE

public static final Emoticon SMILE

SAD

public static final Emoticon SAD

CHEEKY

public static final Emoticon CHEEKY

LAUGH

public static final Emoticon LAUGH

WINK

public static final Emoticon WINK

THUMBS_UP

public static final Emoticon THUMBS_UP

THUMBS_DOWN

public static final Emoticon THUMBS_DOWN

INFORMATION

public static final Emoticon INFORMATION

TICK

public static final Emoticon TICK

CROSS

public static final Emoticon CROSS

WARNING

public static final Emoticon WARNING

PLUS

public static final Emoticon PLUS

MINUS

public static final Emoticon MINUS

QUESTION

public static final Emoticon QUESTION

LIGHT_ON

public static final Emoticon LIGHT_ON

LIGHT_OFF

public static final Emoticon LIGHT_OFF

YELLOW_STAR

public static final Emoticon YELLOW_STAR

RED_STAR

public static final Emoticon RED_STAR

GREEN_STAR

public static final Emoticon GREEN_STAR

BLUE_STAR

public static final Emoticon BLUE_STAR

HEART

public static final Emoticon HEART

BROKEN_HEART

public static final Emoticon BROKEN_HEART

Field Detail

IDENTIFYING_ATTRIBUTE_NAME

public static final String IDENTIFYING_ATTRIBUTE_NAME

Used to identify UI elements as being emoticons.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getType

public String getType()

isSecret

public boolean isSecret()

get

public static Emoticon get(String type)

notSecretValues

public static Emoticon[] notSecretValues()