Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vdurmont/emoji-java
The missing emoji library for Java :heart:
https://github.com/vdurmont/emoji-java
Last synced: 3 days ago
JSON representation
The missing emoji library for Java :heart:
- Host: GitHub
- URL: https://github.com/vdurmont/emoji-java
- Owner: vdurmont
- License: mit
- Created: 2014-09-21T16:58:57.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-03-29T19:35:14.000Z (10 months ago)
- Last Synced: 2025-01-08T21:07:13.479Z (10 days ago)
- Language: Java
- Homepage:
- Size: 526 KB
- Stars: 2,632
- Watchers: 109
- Forks: 514
- Open Issues: 83
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-ccamel - vdurmont/emoji-java - The missing emoji library for Java :heart: (Java)
README
# emoji-java
[](https://travis-ci.org/vdurmont/emoji-java)
[](https://coveralls.io/r/vdurmont/emoji-java?branch=master)
[](https://github.com/vdurmont/emoji-java/blob/master/LICENSE.md)
_The missing emoji library for java._
**emoji-java** is a lightweight java library that helps you use Emojis in your java applications.
## How to get it?
##### Via Maven:
```xml
com.vdurmont
emoji-java
5.1.1
```
You can also download the project, build it with `mvn clean install` and add the generated jar to your buildpath.
##### Via Gradle:
```gradle
compile 'com.vdurmont:emoji-java:5.1.1'
```
##### Via Direct Download:
- Use [releases](https://github.com/vdurmont/emoji-java/releases) tab to download the jar directly.
- Download JSON-java dependency from http://mvnrepository.com/artifact/org.json/json.
## How to use it?
### EmojiManager
The `EmojiManager` provides several static methods to search through 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
- `containsEmoji` checks if a string contains any emoji
You can also query the metadata:
- `getAllTags` returns the available tags
Or get everything:
- `getAll` returns all the emojis
### Emoji model
An `Emoji` is a POJO (plain old java object), which provides the following methods:
- `getUnicode` returns the unicode representation of the emoji
- `getUnicode(Fitzpatrick)` returns the unicode representation of the emoji with the provided Fitzpatrick modifier. If the emoji doesn't support the Fitzpatrick modifiers, this method will throw an `UnsupportedOperationException`. If the provided Fitzpatrick is null, this method will return the unicode 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
- `supportsFitzpatrick` returns true if the emoji supports the Fitzpatrick modifiers, else false
### Fitzpatrick modifiers
Some emojis now support the use of Fitzpatrick modifiers that gives the choice between 5 shades of skin tones:
| Modifier | Type |
| :------: | -------- |
| 🏻 | type_1_2 |
| 🏼 | type_3 |
| 🏽 | type_4 |
| 🏾 | type_5 |
| 🏿 | type_6 |
We defined the format of the aliases including a Fitzpatrick modifier as:
```
:ALIAS|TYPE:
```
A few examples:
```
:boy|type_1_2:
:swimmer|type_4:
:santa|type_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:
```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!"
```
#### To aliases
To replace all the emoji's unicodes found in a string by their aliases, use `EmojiParser#parseToAliases(String)`.
For example:
```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!"
```
By default, the aliases will parse and include any Fitzpatrick modifier that would be provided. If you want to remove or ignore the Fitzpatrick modifiers, use `EmojiParser#parseToAliases(String, FitzpatrickAction)`. Examples:
```java
String str = "Here is a boy: \uD83D\uDC66\uD83C\uDFFF!";
System.out.println(EmojiParser.parseToAliases(str));
System.out.println(EmojiParser.parseToAliases(str, FitzpatrickAction.PARSE));
// Prints twice: "Here is a boy: :boy|type_6:!"
System.out.println(EmojiParser.parseToAliases(str, FitzpatrickAction.REMOVE));
// Prints: "Here is a boy: :boy:!"
System.out.println(EmojiParser.parseToAliases(str, FitzpatrickAction.IGNORE));
// Prints: "Here is a boy: :boy:🏿!"
```
#### To html
To replace all the emoji's unicodes found in a string by their html representation, use `EmojiParser#parseToHtmlDecimal(String)` or `EmojiParser#parseToHtmlHexadecimal(String)`.
For example:
```java
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!"
```
By default, any Fitzpatrick modifier will be removed. If you want to ignore the Fitzpatrick modifiers, use `EmojiParser#parseToAliases(String, FitzpatrickAction)`. Examples:
```java
String str = "Here is a boy: \uD83D\uDC66\uD83C\uDFFF!";
System.out.println(EmojiParser.parseToHtmlDecimal(str));
System.out.println(EmojiParser.parseToHtmlDecimal(str, FitzpatrickAction.PARSE));
System.out.println(EmojiParser.parseToHtmlDecimal(str, FitzpatrickAction.REMOVE));
// Print 3 times: "Here is a boy: 👦!"
System.out.println(EmojiParser.parseToHtmlDecimal(str, FitzpatrickAction.IGNORE));
// Prints: "Here is a boy: 👦🏿!"
```
The same applies for the methods `EmojiParser#parseToHtmlHexadecimal(String)` and `EmojiParser#parseToHtmlHexadecimal(String, FitzpatrickAction)`.
#### Remove emojis
You can easily remove emojis from a string using one of the following methods:
- `EmojiParser#removeAllEmojis(String)`: removes all the emojis from the String
- `EmojiParser#removeAllEmojisExcept(String, Collection)`: removes all the emojis from the String, except the ones in the Collection
- `EmojiParser#removeEmojis(String, Collection)`: removes the emojis in the Collection from the String
For example:
```java
String str = "An 😀awesome 😃string with a few 😉emojis!";
Collection collection = new ArrayList();
collection.add(EmojiManager.getForAlias("wink")); // This is 😉
System.out.println(EmojiParser.removeAllEmojis(str));
System.out.println(EmojiParser.removeAllEmojisExcept(str, collection));
System.out.println(EmojiParser.removeEmojis(str, collection));
// Prints:
// "An awesome string with a few emojis!"
// "An awesome string with a few 😉emojis!"
// "An 😀awesome 😃string with a few emojis!"
```
#### Extract Emojis from a string
You can search a string of mixed emoji/non-emoji characters and have all of the emoji characters returned as a Collection.
- `EmojiParser#extractEmojis(String)`: returns all emojis as a Collection. This will include duplicates if emojis are present more than once.
## Credits
**emoji-java** originally used the data provided by the [github/gemoji project](https://github.com/github/gemoji). It is still based on it but has evolved since.
## Available Emojis
See a table of the available emojis and their aliases [HERE](./EMOJIS.md).