EmojiParser (emoji-java 1.0.0 API)

java.lang.Object
- com.github.sinboun.EmojiParser

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

作者:

Vincent DURMONT [vdurmont@gmail.com]

嵌套类概要

嵌套类
限定符和类型	类和说明
`protected static class`	`EmojiParser.AliasCandidate`
`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`

构造器概要

构造器
构造器和说明

EmojiParser()

构造器
构造器和说明
`EmojiParser()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static java.util.List<java.lang.String>`	`extractEmojis(java.lang.String input)`
`protected static java.util.List<EmojiParser.AliasCandidate>`	`getAliasCandidates(java.lang.String input)`
`protected static int`	`getEmojiEndPos(char[] text, int startPos)` Returns end index of a unicode emoji if it is found in text starting at index startPos, -1 if not found.
`protected static EmojiParser.UnicodeCandidate`	`getNextUnicodeCandidate(char[] chars, int start)` Finds the next UnicodeCandidate after a given starting index
`protected static java.util.List<EmojiParser.UnicodeCandidate>`	`getUnicodeCandidates(java.lang.String input)` Generates a list UnicodeCandidates found in input string.
`static java.lang.String`	`parseFromUnicode(java.lang.String input, EmojiParser.EmojiTransformer transformer)` Detects all unicode emojis in input string and replaces them with the return value of transformer.transform()
`static java.lang.String`	`parseToAliases(java.lang.String input)` See `parseToAliases(String, FitzpatrickAction)` with the action "PARSE"
`static java.lang.String`	`parseToAliases(java.lang.String input, EmojiParser.FitzpatrickAction fitzpatrickAction)` Replaces the emoji's unicode occurrences by one of their alias (between 2 ':').
`static java.lang.String`	`parseToHtmlDecimal(java.lang.String input)` See `parseToHtmlDecimal(String, FitzpatrickAction)` with the action "PARSE"
`static java.lang.String`	`parseToHtmlDecimal(java.lang.String input, EmojiParser.FitzpatrickAction fitzpatrickAction)` Replaces the emoji's unicode occurrences by their html representation.
`static java.lang.String`	`parseToHtmlHexadecimal(java.lang.String input)` See `parseToHtmlHexadecimal(String, FitzpatrickAction)` with the action "PARSE"
`static java.lang.String`	`parseToHtmlHexadecimal(java.lang.String input, EmojiParser.FitzpatrickAction fitzpatrickAction)` Replaces the emoji's unicode occurrences by their html hex representation.
`static java.lang.String`	`parseToUnicode(java.lang.String input)` Replaces the emoji's aliases (between 2 ':') occurrences and the html representations by their unicode.
`static java.lang.String`	`removeAllEmojis(java.lang.String str)` Removes all emojis from a String
`static java.lang.String`	`removeAllEmojisExcept(java.lang.String str, java.util.Collection<Emoji> emojisToKeep)` Removes all the emojis in a String except a provided set
`static java.lang.String`	`removeEmojis(java.lang.String str, java.util.Collection<Emoji> emojisToRemove)` Removes a set of emojis from a String
`static java.lang.String`	`replaceAllEmojis(java.lang.String str, java.lang.String replacementString)` Replace all emojis with character

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - EmojiParser
```
public EmojiParser()
```
- 方法详细资料
  - parseToAliases
```
public static java.lang.String parseToAliases(java.lang.String input)
```
    See parseToAliases(String, FitzpatrickAction) with the action "PARSE"
    
    参数:
    
    input - the string to parse
    
    返回:
    
    the string with the emojis replaced by their alias.
  - parseToAliases
```
public static java.lang.String parseToAliases(java.lang.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:🏿
    
    参数:
    
    input - the string to parse
    
    fitzpatrickAction - the action to apply for the fitzpatrick modifiers
    
    返回:
    
    the string with the emojis replaced by their alias.
  - replaceAllEmojis
```
public static java.lang.String replaceAllEmojis(java.lang.String str,
                                                java.lang.String replacementString)
```
    Replace all emojis with character
    
    参数:
    
    str - the string to process
    
    replacementString - replacement the string that will replace all the emojis
    
    返回:
    
    the string with replaced character
  - parseToUnicode
```
public static java.lang.String parseToUnicode(java.lang.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 👦🏿
    
    参数:
    
    input - the string to parse
    
    返回:
    
    the string with the aliases and html representations replaced by their unicode.
  - getAliasCandidates
```
protected static java.util.List<EmojiParser.AliasCandidate> getAliasCandidates(java.lang.String input)
```
  - parseToHtmlDecimal
```
public static java.lang.String parseToHtmlDecimal(java.lang.String input)
```
    See parseToHtmlDecimal(String, FitzpatrickAction) with the action "PARSE"
    
    参数:
    
    input - the string to parse
    
    返回:
    
    the string with the emojis replaced by their html decimal representation.
  - parseToHtmlDecimal
```
public static java.lang.String parseToHtmlDecimal(java.lang.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 👦🏿
    
    参数:
    
    input - the string to parse
    
    fitzpatrickAction - the action to apply for the fitzpatrick modifiers
    
    返回:
    
    the string with the emojis replaced by their html decimal representation.
  - parseToHtmlHexadecimal
```
public static java.lang.String parseToHtmlHexadecimal(java.lang.String input)
```
    See parseToHtmlHexadecimal(String, FitzpatrickAction) with the action "PARSE"
    
    参数:
    
    input - the string to parse
    
    返回:
    
    the string with the emojis replaced by their html hex representation.
  - parseToHtmlHexadecimal
```
public static java.lang.String parseToHtmlHexadecimal(java.lang.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 👦🏿
    
    参数:
    
    input - the string to parse
    
    fitzpatrickAction - the action to apply for the fitzpatrick modifiers
    
    返回:
    
    the string with the emojis replaced by their html hex representation.
  - removeAllEmojis
```
public static java.lang.String removeAllEmojis(java.lang.String str)
```
    Removes all emojis from a String
    
    参数:
    
    str - the string to process
    
    返回:
    
    the string without any emoji
  - removeEmojis
```
public static java.lang.String removeEmojis(java.lang.String str,
                                            java.util.Collection<Emoji> emojisToRemove)
```
    Removes a set of emojis from a String
    
    参数:
    
    str - the string to process
    
    emojisToRemove - the emojis to remove from this string
    
    返回:
    
    the string without the emojis that were removed
  - removeAllEmojisExcept
```
public static java.lang.String removeAllEmojisExcept(java.lang.String str,
                                                     java.util.Collection<Emoji> emojisToKeep)
```
    Removes all the emojis in a String except a provided set
    
    参数:
    
    str - the string to process
    
    emojisToKeep - the emojis to keep in this string
    
    返回:
    
    the string without the emojis that were removed
  - parseFromUnicode
```
public static java.lang.String parseFromUnicode(java.lang.String input,
                                                EmojiParser.EmojiTransformer transformer)
```
    Detects all unicode emojis in input string and replaces them with the return value of transformer.transform()
    
    参数:
    
    input - the string to process
    
    transformer - emoji transformer to apply to each emoji
    
    返回:
    
    input string with all emojis transformed
  - extractEmojis
```
public static java.util.List<java.lang.String> extractEmojis(java.lang.String input)
```
  - getUnicodeCandidates
```
protected static java.util.List<EmojiParser.UnicodeCandidate> getUnicodeCandidates(java.lang.String input)
```
    Generates a list UnicodeCandidates found in input string. A UnicodeCandidate is created for every unicode emoticon found in input string, additionally if Fitzpatrick modifier follows the emoji, it is included in UnicodeCandidate. Finally, it contains start and end index of unicode emoji itself (WITHOUT Fitzpatrick modifier whether it is there or not!).
    
    参数:
    
    input - String to find all unicode emojis in
    
    返回:
    
    List of UnicodeCandidates for each unicode emote in text
  - getNextUnicodeCandidate
```
protected static EmojiParser.UnicodeCandidate getNextUnicodeCandidate(char[] chars,
                                                                      int start)
```
    Finds the next UnicodeCandidate after a given starting index
    
    参数:
    
    chars - char array to find UnicodeCandidate in
    
    start - starting index for search
    
    返回:
    
    the next UnicodeCandidate or null if no UnicodeCandidate is found after start index
  - getEmojiEndPos
```
protected static int getEmojiEndPos(char[] text,
                                    int startPos)
```
    Returns end index of a unicode emoji if it is found in text starting at index startPos, -1 if not found. This returns the longest matching emoji, for example, in "👨‍👩‍👦" it will find alias:family_man_woman_boy, NOT alias:man
    
    参数:
    
    text - the current text where we are looking for an emoji
    
    startPos - the position in the text where we should start looking for an emoji end
    
    返回:
    
    the end index of the unicode emoji starting at startPos. -1 if not found

类 EmojiParser

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

EmojiParser

方法详细资料

parseToAliases

parseToAliases

replaceAllEmojis

parseToUnicode

getAliasCandidates

parseToHtmlDecimal

parseToHtmlDecimal

parseToHtmlHexadecimal

parseToHtmlHexadecimal

removeAllEmojis

removeEmojis

removeAllEmojisExcept

parseFromUnicode

extractEmojis

getUnicodeCandidates

getNextUnicodeCandidate

getEmojiEndPos