Package org.javacord.api.entity.message

Enum MessageDecoration

java.lang.Object

java.lang.Enum<MessageDecoration>

org.javacord.api.entity.message.MessageDecoration

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MessageDecoration>

public enum MessageDecoration
extends java.lang.Enum<MessageDecoration>

All basic decorations available in discord.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOLD
CODE_LONG
CODE_SIMPLE
ITALICS
SPOILER
STRIKEOUT
UNDERLINE

Method Summary

Modifier and Type	Method	Description
java.lang.String	getPrefix()	Gets the prefix of the decoration.
java.lang.String	getSuffix()	Gets the suffix of the decoration.
static MessageDecoration	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static MessageDecoration[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ITALICS

public static final MessageDecoration ITALICS

BOLD

public static final MessageDecoration BOLD

STRIKEOUT

public static final MessageDecoration STRIKEOUT

CODE_SIMPLE

public static final MessageDecoration CODE_SIMPLE

CODE_LONG

public static final MessageDecoration CODE_LONG

UNDERLINE

public static final MessageDecoration UNDERLINE

SPOILER

public static final MessageDecoration SPOILER

Method Detail

values

public static MessageDecoration[] 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 (MessageDecoration c : MessageDecoration.values())
    System.out.println(c);

Returns:

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

valueOf

public static MessageDecoration valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getPrefix

public java.lang.String getPrefix()

Gets the prefix of the decoration.

Returns:

The prefix of the decoration.

getSuffix

public java.lang.String getSuffix()

Gets the suffix of the decoration.

Returns:

The suffix of the decoration.