EmojiParser (emoji-java 5.0.0 API)

java.lang.Object
- com.vdurmont.emoji.EmojiParser

```
public class EmojiParser
extends Object
```
Provides methods to parse strings with emojis.

Author:

Vincent DURMONT [[email protected]]

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`EmojiParser.EmojiTransformer`
`static class`	`EmojiParser.FitzpatrickAction` Enum used to indicate what should be done when a Fitzpatrick modifier is found.
`static class`	`EmojiParser.UnicodeCandidate`

Constructor Summary

Constructors
Constructor and Description

EmojiParser()

Constructors
Constructor and Description
`EmojiParser()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static List<String>`	`extractEmojis(String input)`
`static String`	`parseFromUnicode(String input, EmojiParser.EmojiTransformer transformer)` Detects all unicode emojis in input string and replaces them with the return value of transformer.transform()
`static String`	`parseToAliases(String input)` See `parseToAliases(String, FitzpatrickAction)` with the action "PARSE"
`static String`	`parseToAliases(String input, EmojiParser.FitzpatrickAction fitzpatrickAction)` Replaces the emoji's unicode occurrences by one of their alias (between 2 ':'). Example: `😄` will be replaced by `:smile:` When a fitzpatrick modifier is present with a PARSE action, a "\|" will be appendend to the alias, with the fitzpatrick type. Example: `👦🏿` will be replaced by `:boy\|type_6:` The fitzpatrick types are: type_1_2, type_3, type_4, type_5, type_6 When a fitzpatrick modifier is present with a REMOVE action, the modifier will be deleted. Example: `👦🏿` will be replaced by `:boy:` When a fitzpatrick modifier is present with a IGNORE action, the modifier will be ignored. Example: `👦🏿` will be replaced by `:boy:🏿`
`static String`	`parseToHtmlDecimal(String input)` See `parseToHtmlDecimal(String, FitzpatrickAction)` with the action "PARSE"
`static String`	`parseToHtmlDecimal(String input, EmojiParser.FitzpatrickAction fitzpatrickAction)` Replaces the emoji's unicode occurrences by their html representation. Example: `😄` will be replaced by `😄` When a fitzpatrick modifier is present with a PARSE or REMOVE action, the modifier will be deleted from the string. Example: `👦🏿` will be replaced by `👦` When a fitzpatrick modifier is present with a IGNORE action, the modifier will be ignored and will remain in the string. Example: `👦🏿` will be replaced by `👦🏿`
`static String`	`parseToHtmlHexadecimal(String input)` See `parseToHtmlHexadecimal(String, FitzpatrickAction)` with the action "PARSE"
`static String`	`parseToHtmlHexadecimal(String input, EmojiParser.FitzpatrickAction fitzpatrickAction)` Replaces the emoji's unicode occurrences by their html hex representation. Example: `👦` will be replaced by `👦` When a fitzpatrick modifier is present with a PARSE or REMOVE action, the modifier will be deleted. Example: `👦🏿` will be replaced by `👦` When a fitzpatrick modifier is present with a IGNORE action, the modifier will be ignored and will remain in the string. Example: `👦🏿` will be replaced by `👦🏿`
`static String`	`parseToUnicode(String input)` Replaces the emoji's aliases (between 2 ':') occurrences and the html representations by their unicode. Examples: `:smile:` will be replaced by `😄` `😄` will be replaced by `😄` `:boy\|type_6:` will be replaced by `👦🏿`
`static String`	`removeAllEmojis(String str)` Removes all emojis from a String
`static String`	`removeAllEmojisExcept(String str, Collection<Emoji> emojisToKeep)` Removes all the emojis in a String except a provided set
`static String`	`removeEmojis(String str, Collection<Emoji> emojisToRemove)` Removes a set of emojis from a String
`static String`	`replaceAllEmojis(String str, String replacementString)` Replace all emojis with character

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EmojiParser
```
public EmojiParser()
```
- Method Detail
  - parseToAliases
```
public static String parseToAliases(String input)
```
    See parseToAliases(String, FitzpatrickAction) with the action "PARSE"
    
    Parameters:
    
    input - the string to parse
    
    Returns:
    
    the string with the emojis replaced by their alias.
  - parseToAliases
```
public static String parseToAliases(String input,
                                    EmojiParser.FitzpatrickAction fitzpatrickAction)
```
    Replaces the emoji's unicode occurrences by one of their alias (between 2 ':').
    Example: 😄 will be replaced by :smile:
    
    When a fitzpatrick modifier is present with a PARSE action, a "|" will be appendend to the alias, with the fitzpatrick type.
    Example: 👦🏿 will be replaced by :boy|type_6:
    The fitzpatrick types are: type_1_2, type_3, type_4, type_5, type_6
    
    When a fitzpatrick modifier is present with a REMOVE action, the modifier will be deleted.
    Example: 👦🏿 will be replaced by :boy:
    
    When a fitzpatrick modifier is present with a IGNORE action, the modifier will be ignored.
    Example: 👦🏿 will be replaced by :boy:🏿
    
    Parameters:
    
    input - the string to parse
    
    fitzpatrickAction - the action to apply for the fitzpatrick modifiers
    
    Returns:
    
    the string with the emojis replaced by their alias.
  - replaceAllEmojis
```
public static String replaceAllEmojis(String str,
                                      String replacementString)
```
    Replace all emojis with character
    
    Parameters:
    
    str - the string to process
    
    replacementString - replacement the string that will replace all the emojis
    
    Returns:
    
    the string with replaced character
  - parseToUnicode
```
public static String parseToUnicode(String input)
```
    Replaces the emoji's aliases (between 2 ':') occurrences and the html representations by their unicode.
    Examples:
    :smile: will be replaced by 😄
    😄 will be replaced by 😄
    :boy|type_6: will be replaced by 👦🏿
    
    Parameters:
    
    input - the string to parse
    
    Returns:
    
    the string with the aliases and html representations replaced by their unicode.
  - parseToHtmlDecimal
```
public static String parseToHtmlDecimal(String input)
```
    See parseToHtmlDecimal(String, FitzpatrickAction) with the action "PARSE"
    
    Parameters:
    
    input - the string to parse
    
    Returns:
    
    the string with the emojis replaced by their html decimal representation.
  - parseToHtmlDecimal
```
public static String parseToHtmlDecimal(String input,
                                        EmojiParser.FitzpatrickAction fitzpatrickAction)
```
    Replaces the emoji's unicode occurrences by their html representation.
    Example: 😄 will be replaced by 😄
    
    When a fitzpatrick modifier is present with a PARSE or REMOVE action, the modifier will be deleted from the string.
    Example: 👦🏿 will be replaced by 👦
    
    When a fitzpatrick modifier is present with a IGNORE action, the modifier will be ignored and will remain in the string.
    Example: 👦🏿 will be replaced by 👦🏿
    
    Parameters:
    
    input - the string to parse
    
    fitzpatrickAction - the action to apply for the fitzpatrick modifiers
    
    Returns:
    
    the string with the emojis replaced by their html decimal representation.
  - parseToHtmlHexadecimal
```
public static String parseToHtmlHexadecimal(String input)
```
    See parseToHtmlHexadecimal(String, FitzpatrickAction) with the action "PARSE"
    
    Parameters:
    
    input - the string to parse
    
    Returns:
    
    the string with the emojis replaced by their html hex representation.
  - parseToHtmlHexadecimal
```
public static String parseToHtmlHexadecimal(String input,
                                            EmojiParser.FitzpatrickAction fitzpatrickAction)
```
    Replaces the emoji's unicode occurrences by their html hex representation.
    Example: 👦 will be replaced by 👦
    
    When a fitzpatrick modifier is present with a PARSE or REMOVE action, the modifier will be deleted.
    Example: 👦🏿 will be replaced by 👦
    
    When a fitzpatrick modifier is present with a IGNORE action, the modifier will be ignored and will remain in the string.
    Example: 👦🏿 will be replaced by 👦🏿
    
    Parameters:
    
    input - the string to parse
    
    fitzpatrickAction - the action to apply for the fitzpatrick modifiers
    
    Returns:
    
    the string with the emojis replaced by their html hex representation.
  - removeAllEmojis
```
public static String removeAllEmojis(String str)
```
    Removes all emojis from a String
    
    Parameters:
    
    str - the string to process
    
    Returns:
    
    the string without any emoji
  - removeEmojis
```
public static String removeEmojis(String str,
                                  Collection<Emoji> emojisToRemove)
```
    Removes a set of emojis from a String
    
    Parameters:
    
    str - the string to process
    
    emojisToRemove - the emojis to remove from this string
    
    Returns:
    
    the string without the emojis that were removed
  - removeAllEmojisExcept
```
public static String removeAllEmojisExcept(String str,
                                           Collection<Emoji> emojisToKeep)
```
    Removes all the emojis in a String except a provided set
    
    Parameters:
    
    str - the string to process
    
    emojisToKeep - the emojis to keep in this string
    
    Returns:
    
    the string without the emojis that were removed
  - parseFromUnicode
```
public static String parseFromUnicode(String input,
                                      EmojiParser.EmojiTransformer transformer)
```
    Detects all unicode emojis in input string and replaces them with the return value of transformer.transform()
    
    Parameters:
    
    input - the string to process
    
    transformer - emoji transformer to apply to each emoji
    
    Returns:
    
    input string with all emojis transformed
  - extractEmojis
```
public static List<String> extractEmojis(String input)
```

Class EmojiParser

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EmojiParser

Method Detail

parseToAliases

parseToAliases

replaceAllEmojis

parseToUnicode

parseToHtmlDecimal

parseToHtmlDecimal

parseToHtmlHexadecimal

parseToHtmlHexadecimal

removeAllEmojis

removeEmojis

removeAllEmojisExcept

parseFromUnicode

extractEmojis