Package net.dv8tion.jda.api.interactions.modals.tree

Interface ModalComponentTree

All Superinterfaces:

ComponentTree<ModalTopLevelComponentUnion>

public interface ModalComponentTree
extends ComponentTree<ModalTopLevelComponentUnion>

Specialization of ComponentTree for top-level modal components

Use the static methods to construct a ModalComponentTree.

See Also:

• ComponentTree

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.components.tree.ComponentTree

ComponentTree.Type

Method Summary

Modifier and Type	Method	Description
default ModalComponentTree	asDisabled()	Disables all components which can be disabled, and constructs a new tree from the result.
default ModalComponentTree	asEnabled()	Enables all components which can be enabled, and constructs a new tree from the result.
static ModalComponentTree	of(Collection<? extends ModalTopLevelComponent> components)	Creates a ModalComponentTree from the given top-level modal components.
static ModalComponentTree	of(ModalTopLevelComponent... components)	Creates a ModalComponentTree from the given top-level modal components.
ModalComponentTree	replace(ComponentReplacer replacer)	Replaces and/or removes components using the provided ComponentReplacer, and construct a new tree from the result.
ModalComponentTree	withDisabled(boolean disabled)	Enables or disables all components which can be enabled/disabled, and constructs a new tree from the result.

Methods inherited from interface net.dv8tion.jda.api.components.tree.ComponentTree

find, findAll, findAll, getComponents, getType

Method Details

replace

@Nonnull
ModalComponentTree replace(@Nonnull
 ComponentReplacer replacer)

Description copied from interface: ComponentTree

Replaces and/or removes components using the provided ComponentReplacer, and construct a new tree from the result.

Specified by:

replace in interface ComponentTree<ModalTopLevelComponentUnion>

Parameters:

replacer - The ComponentReplacer to apply

Returns:

A new tree with the new components

See Also:

• ComponentReplacer

withDisabled

@Nonnull
@CheckReturnValue
ModalComponentTree withDisabled(boolean disabled)

Description copied from interface: ComponentTree

Enables or disables all components which can be enabled/disabled, and constructs a new tree from the result.

Specified by:

withDisabled in interface ComponentTree<ModalTopLevelComponentUnion>

Returns:

A new tree with all components enabled/disabled.

asDisabled

@Nonnull
@CheckReturnValue
default ModalComponentTree asDisabled()

Description copied from interface: ComponentTree

Disables all components which can be disabled, and constructs a new tree from the result.

Specified by:

asDisabled in interface ComponentTree<ModalTopLevelComponentUnion>

Returns:

A new tree with all components disabled.

asEnabled

@Nonnull
@CheckReturnValue
default ModalComponentTree asEnabled()

Description copied from interface: ComponentTree

Enables all components which can be enabled, and constructs a new tree from the result.

Specified by:

asEnabled in interface ComponentTree<ModalTopLevelComponentUnion>

Returns:

A new tree with all components enabled.

of

@Nonnull
static ModalComponentTree of(@Nonnull
 Collection<? extends ModalTopLevelComponent> components)

Creates a ModalComponentTree from the given top-level modal components.

Parameters:

components - List of components to construct the tree from

Returns:

A ModalComponentTree containing the given components

Throws:

IllegalArgumentException - If null is provided or the collection is empty

of

@Nonnull
static ModalComponentTree of(@Nonnull
 ModalTopLevelComponent... components)

Creates a ModalComponentTree from the given top-level modal components.

Parameters:

components - List of components to construct the tree from

Returns:

A ModalComponentTree containing the given components

Throws:

IllegalArgumentException - If null is provided