Class TextDisplayContainer

java.lang.Object

io.github.kaktushose.jdac.components.internal.AbstractSequencedContainer<TextDisplay, TextDisplayContainer>

io.github.kaktushose.jdac.components.container.TextDisplayContainer

All Implemented Interfaces:

LocalizedComponent, SequencedComponent<TextDisplay>, IDisableable, Component, Container, IComponentUnion, MessageTopLevelComponent, MessageTopLevelComponentUnion, IReplaceable, SerializableData

public final class TextDisplayContainer
extends AbstractSequencedContainer<TextDisplay, TextDisplayContainer>

An implementation of SequencedContainer that only allows TextDisplays.

Example

var container = SequencedTextDisplay.of("Line 1");

container.add("Line 2");

container.addFirst("Line 0");

Nested Class Summary

Nested classes/interfaces inherited from interface Component

Component.Type

Field Summary

Fields inherited from class AbstractSequencedContainer

container, entries

Constructor Summary

Constructors

Constructor	Description
TextDisplayContainer(Resolver<String> resolver, Locale locale, String content)	Constructs a new TextDisplayContainer.
TextDisplayContainer(Resolver<String> resolver, Locale locale, TextDisplay header)	Constructs a new TextDisplayContainer.
TextDisplayContainer(Resolver<String> resolver, DiscordLocale locale, String content)	Constructs a new TextDisplayContainer.
TextDisplayContainer(Resolver<String> resolver, DiscordLocale locale, TextDisplay header)	Constructs a new TextDisplayContainer.

Method Summary

Modifier and Type	Method	Description
TextDisplayContainer	add(String content, Entry... entries)	Appends the provided element to the end of this component.
TextDisplayContainer	addFirst(String content, Entry... entries)	Adds the provided element to this component as the first element of this component.
TextDisplayContainer	addLast(String content, Entry... entries)	Adds the provided element to this component as the last element of this component.
static TextDisplayContainer	of(String content)	Constructs a new TextDisplayContainer from the given String.
static TextDisplayContainer	of(TextDisplay header)	Constructs a new TextDisplayContainer from the given TextDisplay.
protected TextDisplayContainer	self()

Methods inherited from class AbstractSequencedContainer

add, addAll, addFirst, addLast, asActionRow, asContainer, asDisabled, asEnabled, asFileDisplay, asMediaGallery, asSection, asSeparator, asTextDisplay, checkAccess, entries, entries, getAccentColorRaw, getComponents, getType, getUniqueId, isSpoiler, locale, locale, locale, replace, toData, withAccentColor, withAccentColor, withComponents, withComponents, withDisabled, withSpoiler, withUniqueId

Methods inherited from class Object

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

Methods inherited from interface Container

getAccentColor, isDisabled, isEnabled, isMessageCompatible, isModalCompatible

Methods inherited from interface IComponentUnion

isUnknownComponent

Constructor Details

TextDisplayContainer

public TextDisplayContainer(Resolver<String> resolver,
 DiscordLocale locale,
 String content)

Constructs a new TextDisplayContainer.

Parameters:

resolver - the Resolver to use for localization

locale - the locale this container will be localized to

content - the String to use for the first TextDisplay of this container

TextDisplayContainer

public TextDisplayContainer(Resolver<String> resolver,
 DiscordLocale locale,
 TextDisplay header)

Constructs a new TextDisplayContainer.

Parameters:

resolver - the Resolver to use for localization

locale - the locale this container will be localized to

header - the first TextDisplay of this container

TextDisplayContainer

public TextDisplayContainer(Resolver<String> resolver,
 Locale locale,
 String content)

Constructs a new TextDisplayContainer.

Parameters:

resolver - the Resolver to use for localization

locale - the locale this container will be localized to

content - the String to use for the first TextDisplay of this container

TextDisplayContainer

public TextDisplayContainer(Resolver<String> resolver,
 Locale locale,
 TextDisplay header)

Constructs a new TextDisplayContainer.

Parameters:

resolver - the Resolver to use for localization

locale - the locale this container will be localized to

header - the first TextDisplay of this container

Method Details

of

public static TextDisplayContainer of(String content)

Constructs a new TextDisplayContainer from the given String.

This method can only be used inside events or in methods annotated with IntrospectionAccess.

Parameters:

content - the String to use for the first TextDisplay of this container

Throws:

IllegalStateException - if the JDACScope.PREPARATION isn't accessible.

of

public static TextDisplayContainer of(TextDisplay header)

Constructs a new TextDisplayContainer from the given TextDisplay.

This method can only be used inside events or in methods annotated with IntrospectionAccess.

Parameters:

header - the first TextDisplay of this container

Throws:

ReplyException - if the JDACScope.PREPARATION isn't accessible.

add

public TextDisplayContainer add(String content,
 Entry... entries)

Appends the provided element to the end of this component.

Parameters:

content - the content to create the TextDisplay from

entries - the Entries used for localization

Returns:

this instance for fluent interface

addFirst

public TextDisplayContainer addFirst(String content,
 Entry... entries)

Adds the provided element to this component as the first element of this component.

Parameters:

content - the content to create the TextDisplay from

entries - the Entries used for localization

Returns:

this instance for fluent interface

addLast

public TextDisplayContainer addLast(String content,
 Entry... entries)

Adds the provided element to this component as the last element of this component.

Parameters:

content - the content to create the TextDisplay from

entries - the Entries used for localization

Returns:

this instance for fluent interface

self

protected TextDisplayContainer self()

Specified by:

self in class AbstractSequencedContainer<TextDisplay, TextDisplayContainer>