Class AbstractSequencedContainer<E extends Component, R extends AbstractSequencedContainer<E,R>>

java.lang.Object

io.github.kaktushose.jdac.components.internal.AbstractSequencedContainer<E,R>

All Implemented Interfaces:

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

Direct Known Subclasses:

SeparatedContainer, SequencedContainer, TextDisplayContainer

public abstract sealed class AbstractSequencedContainer<E extends Component, R extends AbstractSequencedContainer<E,R>>
extends Object
implements LocalizedComponent, SequencedComponent<E>, Container, MessageTopLevelComponentUnion, SerializableData
permits SeparatedContainer, SequencedContainer<E>, TextDisplayContainer

Nested Class Summary

Nested classes/interfaces inherited from interface Component

Component.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected Container	container
protected final List<Entry>	entries

Constructor Summary

Constructors

Constructor	Description
AbstractSequencedContainer(Resolver<String> resolver, Locale locale, Container container)

Method Summary

Modifier and Type	Method	Description
R	add(E component, Entry... entries)	Appends the provided element to the end of this component.
R	addAll(Collection<E> component, Entry... entries)	Appends all the elements in the specified collection to the end of this component.
R	addFirst(E component, Entry... entries)	Adds the provided element to this component as the first element of this component.
R	addLast(E component, Entry... entries)	Adds the provided element to this component as the last element of this component.
ActionRow	asActionRow()	This method is not supported and will always throw UnsupportedOperationException.
Container	asContainer()
R	asDisabled()
R	asEnabled()
FileDisplay	asFileDisplay()	This method is not supported and will always throw UnsupportedOperationException.
MediaGallery	asMediaGallery()	This method is not supported and will always throw UnsupportedOperationException.
Section	asSection()	This method is not supported and will always throw UnsupportedOperationException.
Separator	asSeparator()	This method is not supported and will always throw UnsupportedOperationException.
TextDisplay	asTextDisplay()	This method is not supported and will always throw UnsupportedOperationException.
protected static void	checkAccess()
R	entries(Entry... entries)	Adds Entries to use for localization.
R	entries(Collection<Entry> entries)	Adds Entries to use for localization.
@Nullable Integer	getAccentColorRaw()
@Unmodifiable List<ContainerChildComponentUnion>	getComponents()	Localizes all components of this container before returning the list.
Component.Type	getType()
int	getUniqueId()
boolean	isSpoiler()
Locale	locale()	Gets the Locale this container will be localized in
R	locale(Locale locale)	Sets the Locale this component will be localized in
R	locale(DiscordLocale locale)	Sets the Locale this component will be localized in
R	replace(ComponentReplacer replacer)
protected abstract R	self()
DataObject	toData()	Localizes all components of this container before returning the DataObject.
R	withAccentColor(@Nullable Color accentColor)
R	withAccentColor(@Nullable Integer accentColor)
R	withComponents(Collection<? extends ContainerChildComponent> components)
R	withComponents(ContainerChildComponent component, ContainerChildComponent... components)
R	withDisabled(boolean disabled)
R	withSpoiler(boolean spoiler)
R	withUniqueId(int uniqueId)

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

Field Details

entries

protected final List<Entry> entries

container

protected Container container

Constructor Details

AbstractSequencedContainer

public AbstractSequencedContainer(Resolver<String> resolver,
 Locale locale,
 Container container)

Method Details

self

protected abstract R self()

locale

public Locale locale()

Description copied from interface: LocalizedComponent

Gets the Locale this container will be localized in

Specified by:

locale in interface LocalizedComponent

Returns:

the Locale

locale

public R locale(DiscordLocale locale)

Description copied from interface: LocalizedComponent

Sets the Locale this component will be localized in

Specified by:

locale in interface LocalizedComponent

Parameters:

locale - the new DiscordLocale to use for localization

Returns:

this instance for fluent interface

locale

public R locale(Locale locale)

Description copied from interface: LocalizedComponent

Sets the Locale this component will be localized in

Specified by:

locale in interface LocalizedComponent

Parameters:

locale - the new Locale to use for localization

Returns:

this instance for fluent interface

entries

public R entries(Entry... entries)

Description copied from interface: LocalizedComponent

Adds Entries to use for localization.

Specified by:

entries in interface LocalizedComponent

Parameters:

entries - the Entries

Returns:

this instance for fluent interface

entries

public R entries(Collection<Entry> entries)

Description copied from interface: LocalizedComponent

Adds Entries to use for localization.

Specified by:

entries in interface LocalizedComponent

Parameters:

entries - the Entries

Returns:

this instance for fluent interface

add

public R add(E component,
 Entry... entries)

Description copied from interface: SequencedComponent

Appends the provided element to the end of this component.

Specified by:

add in interface SequencedComponent<E extends Component>

Parameters:

component - the element to add

entries - the Entries used for localization

Returns:

this instance for fluent interface

addFirst

public R addFirst(E component,
 Entry... entries)

Description copied from interface: SequencedComponent

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

Specified by:

addFirst in interface SequencedComponent<E extends Component>

Parameters:

component - the element to add

entries - the Entries used for localization

Returns:

this instance for fluent interface

addLast

public R addLast(E component,
 Entry... entries)

Description copied from interface: SequencedComponent

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

Specified by:

addLast in interface SequencedComponent<E extends Component>

Parameters:

component - the element to add

entries - the Entries used for localization

Returns:

this instance for fluent interface

addAll

public R addAll(Collection<E> component,
 Entry... entries)

Description copied from interface: SequencedComponent

Appends all the elements in the specified collection to the end of this component.

Specified by:

addAll in interface SequencedComponent<E extends Component>

Parameters:

component - the elements to add

entries - the Entries used for localization

Returns:

this instance for fluent interface

toData

public DataObject toData()

Localizes all components of this container before returning the DataObject.

Specified by:

toData in interface SerializableData

Returns:

getComponents

public @Unmodifiable List<ContainerChildComponentUnion> getComponents()

Localizes all components of this container before returning the list.

Specified by:

getComponents in interface Container

Returns:

replace

public R replace(ComponentReplacer replacer)

Specified by:

replace in interface Container

Specified by:

replace in interface IReplaceable

withAccentColor

public R withAccentColor(@Nullable Integer accentColor)

Specified by:

withAccentColor in interface Container

withAccentColor

public R withAccentColor(@Nullable Color accentColor)

Specified by:

withAccentColor in interface Container

withSpoiler

public R withSpoiler(boolean spoiler)

Specified by:

withSpoiler in interface Container

withComponents

public R withComponents(Collection<? extends ContainerChildComponent> components)

Specified by:

withComponents in interface Container

withComponents

public R withComponents(ContainerChildComponent component,
 ContainerChildComponent... components)

Specified by:

withComponents in interface Container

withDisabled

public R withDisabled(boolean disabled)

Specified by:

withDisabled in interface Container

Specified by:

withDisabled in interface IDisableable

asDisabled

public R asDisabled()

Specified by:

asDisabled in interface Container

Specified by:

asDisabled in interface IDisableable

asEnabled

public R asEnabled()

Specified by:

asEnabled in interface Container

Specified by:

asEnabled in interface IDisableable

withUniqueId

public R withUniqueId(int uniqueId)

Specified by:

withUniqueId in interface Component

Specified by:

withUniqueId in interface Container

Specified by:

withUniqueId in interface IComponentUnion

Specified by:

withUniqueId in interface IDisableable

Specified by:

withUniqueId in interface MessageTopLevelComponent

Specified by:

withUniqueId in interface MessageTopLevelComponentUnion

getType

public Component.Type getType()

Specified by:

getType in interface Component

getUniqueId

public int getUniqueId()

Specified by:

getUniqueId in interface Component

getAccentColorRaw

public @Nullable Integer getAccentColorRaw()

Specified by:

getAccentColorRaw in interface Container

isSpoiler

public boolean isSpoiler()

Specified by:

isSpoiler in interface Container

asContainer

public Container asContainer()

Specified by:

asContainer in interface MessageTopLevelComponentUnion

asActionRow

public ActionRow asActionRow()

This method is not supported and will always throw UnsupportedOperationException.

Specified by:

asActionRow in interface MessageTopLevelComponentUnion

asSection

public Section asSection()

This method is not supported and will always throw UnsupportedOperationException.

Specified by:

asSection in interface MessageTopLevelComponentUnion

asTextDisplay

public TextDisplay asTextDisplay()

This method is not supported and will always throw UnsupportedOperationException.

Specified by:

asTextDisplay in interface MessageTopLevelComponentUnion

asMediaGallery

public MediaGallery asMediaGallery()

This method is not supported and will always throw UnsupportedOperationException.

Specified by:

asMediaGallery in interface MessageTopLevelComponentUnion

asSeparator

public Separator asSeparator()

This method is not supported and will always throw UnsupportedOperationException.

Specified by:

asSeparator in interface MessageTopLevelComponentUnion

asFileDisplay

public FileDisplay asFileDisplay()

This method is not supported and will always throw UnsupportedOperationException.

Specified by:

asFileDisplay in interface MessageTopLevelComponentUnion

checkAccess

protected static void checkAccess()