net.fellbaum.jemoji

Class EmojiManager

java.lang.Object

net.fellbaum.jemoji.EmojiManager

public final class EmojiManager
extends Object

Method Summary

Modifier and Type	Method and Description
static boolean	containsEmoji(String text) Checks if the given text contains emojis.
static Set<Emoji>	extractEmojis(String text) Extracts all emojis from the given text.
static List<Emoji>	extractEmojisInOrder(String text) Extracts all emojis from the given text in the order they appear.
static List<IndexedEmoji>	extractEmojisInOrderWithIndex(String text) Extracts all emojis from the given text in the order they appear.
static Set<Emoji>	getAllEmojis() Gets all emojis.
static Set<Emoji>	getAllEmojisByGroup(EmojiGroup group) Gets all emojis that are part of the given group.
static Set<Emoji>	getAllEmojisBySubGroup(EmojiSubGroup subgroup) Gets all emojis that are part of the given subgroup.
static List<Emoji>	getAllEmojisLengthDescending() Gets all emojis in descending order by their char length.
static Optional<Emoji>	getByAlias(String alias) Gets an emoji for the given alias i.e.
static Optional<Emoji>	getByDiscordAlias(String alias) Gets an emoji for the given Discord alias i.e.
static Optional<Emoji>	getByGithubAlias(String alias) Gets an emoji for the given GitHub alias i.e.
static Optional<Emoji>	getBySlackAlias(String alias) Gets an emoji for the given Slack alias i.e.
static Optional<Emoji>	getEmoji(String emoji) Returns the emoji for the given unicode.
static Pattern	getEmojiPattern() Gets the pattern checking for all emojis.
static boolean	isEmoji(String emoji) Check if the given string is an emoji.
static String	removeAllEmojis(String text) Removes all emojis from the given text.
static String	removeAllEmojisExcept(String text, Collection<Emoji> emojisToKeep) Removes all emojis except the given emojis from the given text.
static String	removeAllEmojisExcept(String text, Emoji... emojisToKeep) Removes all emojis except the given emojis from the given text.
static String	removeEmojis(String text, Collection<Emoji> emojisToRemove) Removes the given emojis from the given text.
static String	removeEmojis(String text, Emoji... emojisToRemove) Removes the given emojis from the given text.
static String	replaceAllEmojis(String text, Function<Emoji,String> replacementFunction) Replaces all emojis in the text with the given replacement function.
static String	replaceAllEmojis(String text, String replacementString) Replaces all emojis in the text with the given replacement string.
static String	replaceEmojis(String text, Function<Emoji,String> replacementFunction, Collection<Emoji> emojisToReplace) Replaces all emojis in the text with the given replacement function.
static String	replaceEmojis(String text, Function<Emoji,String> replacementFunction, Emoji... emojisToReplace) Replaces all emojis in the text with the given replacement function.
static String	replaceEmojis(String text, String replacementString, Collection<Emoji> emojisToReplace) Replaces the given emojis with the given replacement string.
static String	replaceEmojis(String text, String replacementString, Emoji... emojisToReplace) Replaces the given emojis with the given replacement string.

Methods inherited from class java.lang.Object

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

Method Detail

getEmoji

public static Optional<Emoji> getEmoji(String emoji)

Returns the emoji for the given unicode.

Parameters:

emoji - The unicode of the emoji.

Returns:

The emoji.

isEmoji

public static boolean isEmoji(String emoji)

Check if the given string is an emoji.

Parameters:

emoji - The emoji to check.

Returns:

True if the given string is an emoji.

getAllEmojis

public static Set<Emoji> getAllEmojis()

Gets all emojis.

Returns:

A set of all emojis.

getAllEmojisByGroup

public static Set<Emoji> getAllEmojisByGroup(EmojiGroup group)

Gets all emojis that are part of the given group.

Parameters:

group - The group to get the emojis for.

Returns:

A set of all emojis that are part of the given group.

getAllEmojisBySubGroup

public static Set<Emoji> getAllEmojisBySubGroup(EmojiSubGroup subgroup)

Gets all emojis that are part of the given subgroup.

Parameters:

subgroup - The subgroup to get the emojis for.

Returns:

A set of all emojis that are part of the given subgroup.

getAllEmojisLengthDescending

public static List<Emoji> getAllEmojisLengthDescending()

Gets all emojis in descending order by their char length.

Returns:

A list of all emojis.

getByAlias

public static Optional<Emoji> getByAlias(String alias)

Gets an emoji for the given alias i.e. :thumbsup: if present.

Parameters:

alias - The alias of the emoji.

Returns:

The emoji.

getByDiscordAlias

public static Optional<Emoji> getByDiscordAlias(String alias)

Gets an emoji for the given Discord alias i.e. :thumbsup: if present.

Parameters:

alias - The Discord alias of the emoji.

Returns:

The emoji.

getByGithubAlias

public static Optional<Emoji> getByGithubAlias(String alias)

Gets an emoji for the given GitHub alias i.e. :thumbsup: if present.

Parameters:

alias - The GitHub alias of the emoji.

Returns:

The emoji.

getBySlackAlias

public static Optional<Emoji> getBySlackAlias(String alias)

Gets an emoji for the given Slack alias i.e. :thumbsup: if present.

Parameters:

alias - The Slack alias of the emoji.

Returns:

The emoji.

getEmojiPattern

public static Pattern getEmojiPattern()

Gets the pattern checking for all emojis.

Returns:

The pattern for all emojis.

containsEmoji

public static boolean containsEmoji(String text)

Checks if the given text contains emojis.

Parameters:

text - The text to check.

Returns:

True if the given text contains emojis.

extractEmojisInOrder

public static List<Emoji> extractEmojisInOrder(String text)

Extracts all emojis from the given text in the order they appear.

Parameters:

text - The text to extract emojis from.

Returns:

A list of emojis.

extractEmojisInOrderWithIndex

public static List<IndexedEmoji> extractEmojisInOrderWithIndex(String text)

Extracts all emojis from the given text in the order they appear.

Parameters:

text - The text to extract emojis from.

Returns:

A list of indexed emojis.

extractEmojis

public static Set<Emoji> extractEmojis(String text)

Extracts all emojis from the given text.

Parameters:

text - The text to extract emojis from.

Returns:

A list of emojis.

removeAllEmojis

public static String removeAllEmojis(String text)

Removes all emojis from the given text.

Parameters:

text - The text to remove emojis from.

Returns:

The text without emojis.

removeEmojis

public static String removeEmojis(String text,
                                  Emoji... emojisToRemove)

Removes the given emojis from the given text.

Parameters:

text - The text to remove emojis from.

emojisToRemove - The emojis to remove.

Returns:

The text without the given emojis.

removeEmojis

public static String removeEmojis(String text,
                                  Collection<Emoji> emojisToRemove)

Removes the given emojis from the given text.

Parameters:

text - The text to remove emojis from.

emojisToRemove - The emojis to remove.

Returns:

The text without the given emojis.

removeAllEmojisExcept

public static String removeAllEmojisExcept(String text,
                                           Emoji... emojisToKeep)

Removes all emojis except the given emojis from the given text.

Parameters:

text - The text to remove emojis from.

emojisToKeep - The emojis to keep.

Returns:

The text with only the given emojis.

removeAllEmojisExcept

public static String removeAllEmojisExcept(String text,
                                           Collection<Emoji> emojisToKeep)

Removes all emojis except the given emojis from the given text.

Parameters:

text - The text to remove emojis from.

emojisToKeep - The emojis to keep.

Returns:

The text with only the given emojis.

replaceAllEmojis

public static String replaceAllEmojis(String text,
                                      String replacementString)

Replaces all emojis in the text with the given replacement string.

Parameters:

text - The text to replace emojis from.

replacementString - The replacement string.

Returns:

The text with all emojis replaced.

replaceAllEmojis

public static String replaceAllEmojis(String text,
                                      Function<Emoji,String> replacementFunction)

Replaces all emojis in the text with the given replacement function.

Parameters:

text - The text to replace emojis from.

replacementFunction - The replacement function.

Returns:

The text with all emojis replaced.

replaceEmojis

public static String replaceEmojis(String text,
                                   String replacementString,
                                   Collection<Emoji> emojisToReplace)

Replaces the given emojis with the given replacement string.

Parameters:

text - The text to replace emojis from.

replacementString - The replacement string.

emojisToReplace - The emojis to replace.

Returns:

The text with the given emojis replaced.

replaceEmojis

public static String replaceEmojis(String text,
                                   String replacementString,
                                   Emoji... emojisToReplace)

Replaces the given emojis with the given replacement string.

Parameters:

text - The text to replace emojis from.

replacementString - The replacement string.

emojisToReplace - The emojis to replace.

Returns:

The text with the given emojis replaced.

replaceEmojis

public static String replaceEmojis(String text,
                                   Function<Emoji,String> replacementFunction,
                                   Collection<Emoji> emojisToReplace)

Replaces all emojis in the text with the given replacement function.

Parameters:

text - The text to replace emojis from.

replacementFunction - The replacement function.

emojisToReplace - The emojis to replace.

Returns:

The text with all emojis replaced.

replaceEmojis

public static String replaceEmojis(String text,
                                   Function<Emoji,String> replacementFunction,
                                   Emoji... emojisToReplace)

Replaces all emojis in the text with the given replacement function.

Parameters:

text - The text to replace emojis from.

replacementFunction - The replacement function.

emojisToReplace - The emojis to replace.

Returns:

The text with all emojis replaced.