Awesome

emoji-data-java

The missing emoji library for Java. Based on emoji-data

emoji-data-java is a lightweight Java library that helps you use Emojis in your Java applications.

How to get it?

Via Maven:

<dependency>
  <groupId>com.maximebertheau</groupId>
  <artifactId>emoji-data-java</artifactId>
  <version>2.0</version>
</dependency>

Via Gradle:

implementation("com.maximebertheau:emoji-data-java:2.0")

How to use it?

EmojiManager

The EmojiManager provides several static methods to search through the emojis database:

• getForAlias returns the emoji for an alias
• getByUnicode returns the emoji for a unicode String
• all or getAll() returns all the official emojis
• allWithSkinVariations or getAllWithSkinVariations() returns all the emojis and their skin variations in the same array
• isEmoji checks if a String is an emoji
• getByCategory get emojis depending on their Category

Emoji model

An Emoji is a model which provides the following:

• name returns the Unicode standard name of the emoji
• aliases returns a list of aliases for this emoji
• category the category this Emoji lives in
• sortOrder the sort order retrieved from emoji-data
• skinVariations the list of the skin variations available for this Emoji
• unified returns the unicode representation of the emoji

Categories

• Smileys & Emotion
• Symbols
• Objects
• Animals & Nature
• People & Body
• Food & Drink
• Travel & Places
• Activities
• Flags
• Skin Tones

Skin tone (Fitzpatrick) modifiers

Some emojis support the use of Skin tone (Fitzpatrick) modifiers that gives the choice between 5 shades of skin tones:

A few examples:

:boy::skin-tone-2::
:swimmer::skin-tone-4:
:santa::skin-tone-6:

EmojiParser

To unicode

To replace all the aliases and the html representations found in a string by their unicode, use EmojiParser#parseToUnicode(String).

For example:

In Java:

String str = "An :grinning:awesome :smiley:string with a few :wink:emojis!";
String result = EmojiParser.parseToUnicode(str);
System.out.println(result);
// Prints:
// "An 😀awesome 😃string with a few 😉emojis!"

In Kotlin:

val str = "An :grinning:awesome :smiley:string with a few :wink:emojis!"
val result = EmojiParser.parseToUnicode(str)
println(result)
// Prints:
// "An 😀awesome 😃string with a few 😉emojis!"

To aliases

To replace all the emoji's unicodes found in a string by their aliases, use EmojiParser#parseToAliases(String).

For example:

In Java:

String str = "An 😀awesome 😃string with a few 😉emojis!";
String result = EmojiParser.parseToAliases(str);
System.out.println(result);
// Prints:
// "An :grinning:awesome :smiley:string with a few :wink:emojis!"

In Kotlin:

val str = "An 😀awesome 😃string with a few 😉emojis!"
val result = EmojiParser.parseToAliases(str)
println(result)
// Prints:
// "An :grinning:awesome :smiley:string with a few :wink:emojis!"

The aliases will parse and include any Fitzpatrick modifier that would be provided.

String str = "Here is a boy: \uD83D\uDC66\uD83C\uDFFF!";
System.out.println(EmojiParser.parseToAliases(str));
// Prints twice: "Here is a boy: :boy::skin-tone-6:!"

Credits

emoji-java initially based on the great work of the community from vdurmont/emoji-java

emoji-data provides the emojis for the library to work iamcal/emoji-data.

Available Emojis

Here is a table of the available emojis and their aliases.