Class SeparatedContainer

java.lang.Object

io.github.kaktushose.jdac.components.internal.AbstractSequencedContainer<ContainerChildComponent, SeparatedContainer>

io.github.kaktushose.jdac.components.container.SeparatedContainer

All Implemented Interfaces:

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

public final class SeparatedContainer
extends AbstractSequencedContainer<ContainerChildComponent, SeparatedContainer>

An implementation of SequencedContainer that always adds a Separator between its elements.

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
SeparatedContainer(Resolver<String> resolver, Locale locale, ContainerChildComponent header, Separator separator)	Constructs a new SeparatedContainer.
SeparatedContainer(Resolver<String> resolver, DiscordLocale locale, ContainerChildComponent header, Separator separator)	Constructs a new SeparatedContainer.

Method Summary

Modifier and Type	Method	Description
SeparatedContainer	add(ContainerChildComponent component, Entry... entries)	Appends the provided element to the end of this component.
SeparatedContainer	add(ContainerChildComponent component, @Nullable Separator separator, Entry... entries)	Appends a component to the end of this container.
SeparatedContainer	addFirst(ContainerChildComponent component, Entry... entries)	Adds the provided element to this component as the first element of this component.
SeparatedContainer	addFirst(ContainerChildComponent component, @Nullable Separator separator, Entry... entries)	Adds the provided element to this component as the first element of this component.
SeparatedContainer	addLast(ContainerChildComponent component, Entry... entries)	Adds the provided element to this component as the last element of this component.
SeparatedContainer	addUnseparated(ContainerChildComponent component, Entry... entries)	Appends a component to the end of this container without appending a Separator.
static SeparatedContainer	of(ContainerChildComponent header, Separator separator)	Constructs a new SeparatedContainer from the given component.
protected SeparatedContainer	self()

Methods inherited from class AbstractSequencedContainer

addAll, 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

SeparatedContainer

public SeparatedContainer(Resolver<String> resolver,
 DiscordLocale locale,
 ContainerChildComponent header,
 Separator separator)

Constructs a new SeparatedContainer.

Parameters:

resolver - the Resolver to use for localization

locale - the locale this container will be localized to

header - the first component of this container

separator - the Separator to use to divide elements

SeparatedContainer

public SeparatedContainer(Resolver<String> resolver,
 Locale locale,
 ContainerChildComponent header,
 Separator separator)

Constructs a new SeparatedContainer.

Parameters:

resolver - the Resolver to use for localization

locale - the locale this container will be localized to

header - the first component of this container

separator - the Separator to use to divide elements

Method Details

of

public static SeparatedContainer of(ContainerChildComponent header,
 Separator separator)

Constructs a new SeparatedContainer from the given component.

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

Parameters:

header - the first component of this container

separator - the Separator to use to divide elements

Throws:

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

self

protected SeparatedContainer self()

Specified by:

self in class AbstractSequencedContainer<ContainerChildComponent, SeparatedContainer>

add

public SeparatedContainer add(ContainerChildComponent component,
 Entry... entries)

Appends the provided element to the end of this component. Automatically appends the default Separator after the component. Use add(ContainerChildComponent, Separator, Entry...) to override.

Specified by:

add in interface SequencedComponent<ContainerChildComponent>

Overrides:

add in class AbstractSequencedContainer<ContainerChildComponent, SeparatedContainer>

Parameters:

component - the component to add

entries - the Entries used for localization

Returns:

this instance for fluent interface

add

public SeparatedContainer add(ContainerChildComponent component,
 @Nullable Separator separator,
 Entry... entries)

Appends a component to the end of this container. Automatically appends the provided Separator after the component. If null is provided, no Separator will be appended.

Parameters:

component - the component to add

separator - the Separator to append, pass null for no Separator

entries - the Entries used for localization

Returns:

this instance for fluent interface

addFirst

public SeparatedContainer addFirst(ContainerChildComponent component,
 Entry... entries)

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

Automatically appends the default Separator after the component. Use add(ContainerChildComponent, Separator, Entry...) to override.

Specified by:

addFirst in interface SequencedComponent<ContainerChildComponent>

Overrides:

addFirst in class AbstractSequencedContainer<ContainerChildComponent, SeparatedContainer>

Parameters:

component - the component to add

entries - the Entries used for localization

Returns:

this instance for fluent interface

addFirst

public SeparatedContainer addFirst(ContainerChildComponent component,
 @Nullable Separator separator,
 Entry... entries)

Adds the provided element to this component as the first element of this component. Automatically appends the provided Separator after the component. If null is provided, no Separator will be appended.

Parameters:

component - the component to add

separator - the Separator to append, pass null for no Separator

entries - the Entries used for localization

Returns:

this instance for fluent interface

addUnseparated

public SeparatedContainer addUnseparated(ContainerChildComponent component,
 Entry... entries)

Appends a component to the end of this container without appending a Separator.

Parameters:

component - the component to add

entries - the Entries used for localization

addLast

public SeparatedContainer addLast(ContainerChildComponent component,
 Entry... entries)

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

This method doesn't append a Separator and should thus be used for the last component of the container.

Specified by:

addLast in interface SequencedComponent<ContainerChildComponent>

Overrides:

addLast in class AbstractSequencedContainer<ContainerChildComponent, SeparatedContainer>

Parameters:

component - the component to add

entries - the Entries used for localization

Returns:

this instance for fluent interface