com.vdurmont.emoji

Class Emoji

java.lang.Object

com.vdurmont.emoji.Emoji

public class Emoji
extends Object

This class represents an emoji.

This object is immutable so it can be used safely in a multithreaded context.

Author:

Vincent DURMONT [vdurmont@gmail.com]

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
List<String>	getAliases() Returns the aliases of the emoji
String	getDescription() Returns the description of the emoji
String	getHtmlDecimal() Returns the HTML decimal representation of the emoji
String	getHtmlHexidecimal() Returns the HTML hexadecimal representation of the emoji
List<String>	getTags() Returns the tags of the emoji
String	getUnicode() Returns the unicode representation of the emoji
String	getUnicode(Fitzpatrick fitzpatrick) Returns the unicode representation of the emoji associated with the provided Fitzpatrick modifier. If the modifier is null, then the result is similar to getUnicode()
int	hashCode()
boolean	supportsFitzpatrick() Returns wether the emoji supports the Fitzpatrick modifiers or not
String	toString() Returns the String representation of the Emoji object. Example: Emoji{description='smiling face with open mouth and smiling eyes', supportsFitzpatrick=false, aliases=[smile], tags=[happy, joy, pleased], unicode='😄', htmlDec='&#128516;', htmlHex='&#x1f604;'}

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getDescription

public String getDescription()

Returns the description of the emoji

Returns:

the description

supportsFitzpatrick

public boolean supportsFitzpatrick()

Returns wether the emoji supports the Fitzpatrick modifiers or not

Returns:

true if the emoji supports the Fitzpatrick modifiers

getAliases

public List<String> getAliases()

Returns the aliases of the emoji

Returns:

the aliases (unmodifiable)

getTags

public List<String> getTags()

Returns the tags of the emoji

Returns:

the tags (unmodifiable)

getUnicode

public String getUnicode()

Returns the unicode representation of the emoji

Returns:

the unicode representation

getUnicode

public String getUnicode(Fitzpatrick fitzpatrick)

Returns the unicode representation of the emoji associated with the provided Fitzpatrick modifier.
If the modifier is null, then the result is similar to getUnicode()

Parameters:

fitzpatrick - the fitzpatrick modifier or null

Returns:

the unicode representation

Throws:

UnsupportedOperationException - if the emoji doesn't support the Fitzpatrick modifiers

getHtmlDecimal

public String getHtmlDecimal()

Returns the HTML decimal representation of the emoji

Returns:

the HTML decimal representation

getHtmlHexidecimal

public String getHtmlHexidecimal()

Returns the HTML hexadecimal representation of the emoji

Returns:

the HTML hexadecimal representation

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns the String representation of the Emoji object.

Example:
Emoji{description='smiling face with open mouth and smiling eyes', supportsFitzpatrick=false, aliases=[smile], tags=[happy, joy, pleased], unicode='😄', htmlDec='😄', htmlHex='😄'}

Overrides:

toString in class Object

Returns:

the string representation