Package net.dv8tion.jda.api.utils

Enum MarkdownSanitizer.SanitizationStrategy

java.lang.Object

java.lang.Enum<MarkdownSanitizer.SanitizationStrategy>

net.dv8tion.jda.api.utils.MarkdownSanitizer.SanitizationStrategy

All Implemented Interfaces:

Serializable, Comparable<MarkdownSanitizer.SanitizationStrategy>

Enclosing class:

MarkdownSanitizer

public static enum MarkdownSanitizer.SanitizationStrategy
extends Enum<MarkdownSanitizer.SanitizationStrategy>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ESCAPE	Escape any format tokens that are not escaped or within a special region.
REMOVE	Remove any format tokens that are not escaped or within a special region.

Method Summary

Modifier and Type	Method	Description
static MarkdownSanitizer.SanitizationStrategy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MarkdownSanitizer.SanitizationStrategy[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

REMOVE

public static final MarkdownSanitizer.SanitizationStrategy REMOVE

Remove any format tokens that are not escaped or within a special region.
"**Hello** World!" -> "Hello World!"

ESCAPE

public static final MarkdownSanitizer.SanitizationStrategy ESCAPE

Escape any format tokens that are not escaped or within a special region.
"**Hello** World!" -> "\**Hello\** World!"

Method Detail

values

public static MarkdownSanitizer.SanitizationStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MarkdownSanitizer.SanitizationStrategy c : MarkdownSanitizer.SanitizationStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MarkdownSanitizer.SanitizationStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null