Package com.vdurmont.emoji

Class EmojiTrie

java.lang.Object

com.vdurmont.emoji.EmojiTrie

public class EmojiTrie
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EmojiTrie.Matches

Constructor Summary

Constructors

Constructor	Description
EmojiTrie(Collection<Emoji> emojis)

Method Summary

Modifier and Type	Method	Description
@Nullable Emoji	getEmoji(@NotNull String unicode)	Finds Emoji instance from emoji unicode
@NotNull EmojiTrie.Matches	isEmoji(char[] sequence)	Checks if sequence of chars contain an emoji.
@NotNull EmojiTrie.Matches	isEmoji(char[] sequence, int start, int end)	Checks if the sequence of chars within the given bound indices contain an emoji.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EmojiTrie

public EmojiTrie(Collection<Emoji> emojis)

Method Detail

isEmoji

@NotNull
public @NotNull EmojiTrie.Matches isEmoji(char[] sequence)

Checks if sequence of chars contain an emoji.

Parameters:

sequence - Sequence of char that may contain emoji in full or partially.

Returns:

• EmojiTrie.Matches.EXACTLY if char sequence in its entirety is an emoji
• EmojiTrie.Matches.POSSIBLY if char sequence matches prefix of an emoji
• EmojiTrie.Matches.IMPOSSIBLE if char sequence matches no emoji or prefix of an emoji

isEmoji

@NotNull
public @NotNull EmojiTrie.Matches isEmoji(char[] sequence,
                                          int start,
                                          int end)

Checks if the sequence of chars within the given bound indices contain an emoji.

Parameters:

sequence - Sequence of char that may contain emoji in full or partially.

start - The starting index

end - The end index (exclusive)

Returns:

• EmojiTrie.Matches.EXACTLY if char sequence in its entirety is an emoji
• EmojiTrie.Matches.POSSIBLY if char sequence matches prefix of an emoji
• EmojiTrie.Matches.IMPOSSIBLE if char sequence matches no emoji or prefix of an emoji

Throws:

ArrayIndexOutOfBoundsException - If the provided range is invalid

See Also:

isEmoji(char[])

getEmoji

@Nullable
public @Nullable Emoji getEmoji(@NotNull
                                @NotNull String unicode)

Finds Emoji instance from emoji unicode

Parameters:

unicode - unicode of emoji to get

Returns:

Emoji instance if unicode matches and emoji, null otherwise.