net.fellbaum.jemoji

Class Emoji

java.lang.Object

net.fellbaum.jemoji.Emoji

All Implemented Interfaces:

Comparable<Emoji>

public final class Emoji
extends Object
implements Comparable<Emoji>

Represents an emoji.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Emoji o) Compares the emojis based on their codepoint length, and if they are equal, compare them lexicographically based on the emoji.
boolean	equals(Object o)
List<String>	getAllAliases() Gets all the aliases for this emoji.
String	getDescription() Gets the description of this emoji.
Optional<String>	getDescription(EmojiDescriptionLanguage emojiDescriptionLanguage) Gets the description of this emoji in the specified language.
List<String>	getDiscordAliases() Gets the Discord aliases for this emoji.
String	getEmoji() Gets the emoji.
Optional<String>	getEmojiVariation() Gets the emoji representation of this emoji if the emoji is a standardized emoji that allows variations.
List<String>	getGithubAliases() Gets the GitHub aliases for this emoji.
EmojiGroup	getGroup() Gets the group or "category" this emoji belongs to.
String	getHtmlDecimalCode() Gets the HTML decimal code for this emoji.
String	getHtmlHexadecimalCode() Gets the HTML hexadecimal code for this emoji.
Qualification	getQualification() Gets the qualification of this emoji.
List<String>	getSlackAliases() Gets the Slack aliases for this emoji.
EmojiSubGroup	getSubgroup() Gets the subgroup of this emoji.
Optional<String>	getTextVariation() Gets the text representation of this emoji if the emoji is a standardized emoji that allows variations.
String	getUnicode() Gets the unicode representation of the emoji as a string i.e.
String	getURLEncoded() Gets the URL encoded emoji.
List<Emoji>	getVariations() Gets variations of this emoji with different Fitzpatrick or HairStyle modifiers, if there are any.
double	getVersion() Gets the version this emoji was added to the unicode consortium.
boolean	hasFitzpatrickComponent() Checks if this emoji has a fitzpatrick modifier.
boolean	hasHairStyleComponent() Checks if this emoji has a hairstyle modifier.
int	hashCode()
boolean	hasVariationSelectors() Returns whether the emoji has text or emoji variations.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getEmoji

public String getEmoji()

Gets the emoji.

Returns:

The emoji

getUnicode

public String getUnicode()

Gets the unicode representation of the emoji as a string i.e. 👍.

Returns:

The unicode representation of the emoji

getHtmlDecimalCode

public String getHtmlDecimalCode()

Gets the HTML decimal code for this emoji.

Returns:

The HTML decimal code for this emoji.

getHtmlHexadecimalCode

public String getHtmlHexadecimalCode()

Gets the HTML hexadecimal code for this emoji.

Returns:

The HTML hexadecimal code for this emoji.

getVariations

public List<Emoji> getVariations()

Gets variations of this emoji with different Fitzpatrick or HairStyle modifiers, if there are any. The returned list does not include this emoji itself.

Returns:

Variations of this emoji with different Fitzpatrick or HairStyle modifiers, if there are any.

getURLEncoded

public String getURLEncoded()

Gets the URL encoded emoji.

Returns:

The URL encoded emoji

getDiscordAliases

public List<String> getDiscordAliases()

Gets the Discord aliases for this emoji.

Returns:

The Discord aliases for this emoji.

getGithubAliases

public List<String> getGithubAliases()

Gets the GitHub aliases for this emoji.

Returns:

The GitHub aliases for this emoji.

getSlackAliases

public List<String> getSlackAliases()

Gets the Slack aliases for this emoji.

Returns:

The Slack aliases for this emoji.

getAllAliases

public List<String> getAllAliases()

Gets all the aliases for this emoji.

Returns:

All the aliases for this emoji.

hasFitzpatrickComponent

public boolean hasFitzpatrickComponent()

Checks if this emoji has a fitzpatrick modifier.

Returns:

True if this emoji has a fitzpatrick modifier, false otherwise.

hasHairStyleComponent

public boolean hasHairStyleComponent()

Checks if this emoji has a hairstyle modifier.

Returns:

True if this emoji has a hairstyle modifier, false otherwise.

getVersion

public double getVersion()

Gets the version this emoji was added to the unicode consortium.

Returns:

The version this emoji was added to the unicode consortium.

getQualification

public Qualification getQualification()

Gets the qualification of this emoji.

Returns:

The qualification of this emoji.

getDescription

public String getDescription()

Gets the description of this emoji.

Returns:

The description of this emoji.

getDescription

public Optional<String> getDescription(EmojiDescriptionLanguage emojiDescriptionLanguage)

Gets the description of this emoji in the specified language. May not be present for all languages.

Parameters:

emojiDescriptionLanguage - The language type the description should be searched for.

Returns:

The description of this emoji in the specified language.

getGroup

public EmojiGroup getGroup()

Gets the group or "category" this emoji belongs to.

Returns:

The group this emoji belongs to.

getSubgroup

public EmojiSubGroup getSubgroup()

Gets the subgroup of this emoji.

Returns:

The subgroup of this emoji.

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Emoji o)

Compares the emojis based on their codepoint length, and if they are equal, compare them lexicographically based on the emoji.

Specified by:

compareTo in interface Comparable<Emoji>

Parameters:

o - the object to be compared.

Returns:

the value 0 if they are fully equal, 1 if the emoji has more codepoints and has a higher unicode value, otherwise return -1

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hasVariationSelectors

public boolean hasVariationSelectors()

Returns whether the emoji has text or emoji variations. This means the emoji is allowed to be appended with a FE0E or FE0F character to control how the emoji should be displayed.

Returns:

Whether the emoji is a standardized emoji that can be appended with a Variation Selector.

See Also:

Read more here about Emoji Variation Sequences

getTextVariation

public Optional<String> getTextVariation()

Gets the text representation of this emoji if the emoji is a standardized emoji that allows variations.

Returns:

The text variation of this emoji.

getEmojiVariation

public Optional<String> getEmojiVariation()

Gets the emoji representation of this emoji if the emoji is a standardized emoji that allows variations.

Returns:

The emoji variation of this emoji.