emoji-java

The missing emoji library for java.

Based on the data provided by github/gemoji project, emoji-java is a lightweight java library that helps you use Emojis in your java applications.

Just add the dependency to your maven project:

<dependency>
  <groupId>com.vdurmont</groupId>
  <artifactId>emoji-java</artifactId>
  <version>1.1.0</version>
</dependency>

You can also download the project, build it with mvn clean install and add the generated jar to your buildpath.

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

• getForTag returns all the emojis for a given tag
• getForAlias returns the emoji for an alias
• getAll returns all the emojis
• isEmoji checks if a string is an emoji

You can also query the metadata:

• getAllTags returns the available tags

Or get everything:

• getAll returns all the emojis

An Emoji is a POJO (plain old java object), which provides the following methods:

• getUnicode returns the unicode representation of the emoji
• getDescription returns the (optional) description of the emoji
• getAliases returns a list of aliases for this emoji
• getTags returns a list of tags for this emoji
• getHtmlDecimal returns an html decimal representation of the emoji
• getHtmlHexadecimal returns an html decimal representation of the emoji

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

For example:

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!"

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

For example:

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!"

To replace all the emoji's unicodes found in a string by their html representation, use EmojiParser.parseToHtmlDecimal(myString) or EmojiParser.parseToHtmlHexadecimal(myString).

For example:

String str = "An 😀awesome 😃string with a few 😉emojis!";

String resultDecimal = EmojiParser.parseToHtmlDecimal(str);
System.out.println(resultDecimal);
// Prints:
// "An 😀awesome 😃string with a few 😉emojis!"

String resultHexadecimal = EmojiParser.parseToHtmlHexadecimal(str);
System.out.println(resultHexadecimal);
// Prints:
// "An 😀awesome 😃string with a few 😉emojis!"

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