You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-23Lines changed: 23 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ _The missing emoji library for java._
16
16
<dependency>
17
17
<groupId>com.vdurmont</groupId>
18
18
<artifactId>emoji-java</artifactId>
19
-
<version>5.1.0</version>
19
+
<version>5.1.1</version>
20
20
</dependency>
21
21
```
22
22
@@ -25,46 +25,46 @@ You can also download the project, build it with `mvn clean install` and add the
25
25
##### Via Gradle:
26
26
27
27
```gradle
28
-
compile 'com.vdurmont:emoji-java:5.1.0'
28
+
compile 'com.vdurmont:emoji-java:5.1.1'
29
29
```
30
30
31
31
##### Via Direct Download:
32
32
33
-
-Use [releases](https://github.com/vdurmont/emoji-java/releases) tab to download the jar directly.
34
-
-Download JSON-java dependency from http://mvnrepository.com/artifact/org.json/json.
33
+
- Use [releases](https://github.com/vdurmont/emoji-java/releases) tab to download the jar directly.
34
+
- Download JSON-java dependency from http://mvnrepository.com/artifact/org.json/json.
35
35
36
36
## How to use it?
37
37
38
38
### EmojiManager
39
39
40
40
The `EmojiManager` provides several static methods to search through the emojis database:
41
41
42
-
-`getForTag` returns all the emojis for a given tag
43
-
-`getForAlias` returns the emoji for an alias
44
-
-`getAll` returns all the emojis
45
-
-`isEmoji` checks if a string is an emoji
46
-
-`containsEmoji` checks if a string contains any emoji
42
+
-`getForTag` returns all the emojis for a given tag
43
+
-`getForAlias` returns the emoji for an alias
44
+
-`getAll` returns all the emojis
45
+
-`isEmoji` checks if a string is an emoji
46
+
-`containsEmoji` checks if a string contains any emoji
47
47
48
48
You can also query the metadata:
49
49
50
-
-`getAllTags` returns the available tags
50
+
-`getAllTags` returns the available tags
51
51
52
52
Or get everything:
53
53
54
-
-`getAll` returns all the emojis
54
+
-`getAll` returns all the emojis
55
55
56
56
### Emoji model
57
57
58
58
An `Emoji` is a POJO (plain old java object), which provides the following methods:
59
59
60
-
-`getUnicode` returns the unicode representation of the emoji
61
-
-`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.
62
-
-`getDescription` returns the (optional) description of the emoji
63
-
-`getAliases` returns a list of aliases for this emoji
64
-
-`getTags` returns a list of tags for this emoji
65
-
-`getHtmlDecimal` returns an html decimal representation of the emoji
66
-
-`getHtmlHexadecimal` returns an html decimal representation of the emoji
67
-
-`supportsFitzpatrick` returns true if the emoji supports the Fitzpatrick modifiers, else false
60
+
-`getUnicode` returns the unicode representation of the emoji
61
+
-`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.
62
+
-`getDescription` returns the (optional) description of the emoji
63
+
-`getAliases` returns a list of aliases for this emoji
64
+
-`getTags` returns a list of tags for this emoji
65
+
-`getHtmlDecimal` returns an html decimal representation of the emoji
66
+
-`getHtmlHexadecimal` returns an html decimal representation of the emoji
67
+
-`supportsFitzpatrick` returns true if the emoji supports the Fitzpatrick modifiers, else false
68
68
69
69
### Fitzpatrick modifiers
70
70
@@ -173,9 +173,9 @@ The same applies for the methods `EmojiParser#parseToHtmlHexadecimal(String)` an
173
173
174
174
You can easily remove emojis from a string using one of the following methods:
175
175
176
-
-`EmojiParser#removeAllEmojis(String)`: removes all the emojis from the String
177
-
-`EmojiParser#removeAllEmojisExcept(String, Collection<Emoji>)`: removes all the emojis from the String, except the ones in the Collection
178
-
-`EmojiParser#removeEmojis(String, Collection<Emoji>)`: removes the emojis in the Collection from the String
176
+
-`EmojiParser#removeAllEmojis(String)`: removes all the emojis from the String
177
+
-`EmojiParser#removeAllEmojisExcept(String, Collection<Emoji>)`: removes all the emojis from the String, except the ones in the Collection
178
+
-`EmojiParser#removeEmojis(String, Collection<Emoji>)`: removes the emojis in the Collection from the String
0 commit comments