Package org.javacord.api.entity

Interface Nameable

All Superinterfaces:

java.util.Formattable

All Known Subinterfaces:

Activity, ApplicationInfo, ChannelCategory, CustomEmoji, EditableEmbedField, EmbedAuthor, EmbedField, EmbedProvider, KnownCustomEmoji, MessageAuthor, RegularServerChannel, Role, Server, ServerChannel, ServerForumChannel, ServerStageVoiceChannel, ServerTextChannel, ServerThreadChannel, ServerVoiceChannel, Sticker, StickerItem, StickerPack, UnknownRegularServerChannel, UnknownServerChannel, User

All Known Implementing Classes:

AuditLogChangeType, Region

public interface Nameable
extends java.util.Formattable

This class represents an entity which has a name.

If used in a format string, a Nameable will be rendered as the entity's name unless the alternate flag is given.

See Also:

String.format(String, Object...)

Method Summary

Modifier and Type	Method	Description
default void	formatTo(java.util.Formatter formatter, int flags, int width, int precision)
java.lang.String	getName()	Gets the name of the entity.

Method Detail

getName

java.lang.String getName()

Gets the name of the entity.

Returns:

The name of the entity.

formatTo

default void formatTo(java.util.Formatter formatter,
                      int flags,
                      int width,
                      int precision)

Specified by:

formatTo in interface java.util.Formattable