Package net.dv8tion.jda.api.components.tree

Interface MessageComponentTree

All Superinterfaces:

ComponentTree<MessageTopLevelComponentUnion>

All Known Implementing Classes:

MessageComponentTreeImpl

public interface MessageComponentTree
extends ComponentTree<MessageTopLevelComponentUnion>

Specialization of ComponentTree for top-level message components.

Use the static methods to construct a MessageComponentTree.

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 MessageComponentTree	asDisabled()	Disables all components which can be disabled, and constructs a new tree from the result.
default MessageComponentTree	asEnabled()	Enables all components which can be enabled, and constructs a new tree from the result.
static MessageComponentTree	of(Collection<? extends MessageTopLevelComponent> components)	Creates a MessageComponentTree from the given top-level message components.
static MessageComponentTree	of(MessageTopLevelComponent... components)	Creates a MessageComponentTree from the given top-level message components.
MessageComponentTree	replace(ComponentReplacer replacer)	Replaces and/or removes components using the provided ComponentReplacer, and construct a new tree from the result.
MessageComponentTree	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
@CheckReturnValue
MessageComponentTree 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<MessageTopLevelComponentUnion>

Parameters:

replacer - The ComponentReplacer to apply

Returns:

A new tree with the new components

See Also:

• ComponentReplacer

withDisabled

@Nonnull
@CheckReturnValue
MessageComponentTree 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<MessageTopLevelComponentUnion>

Returns:

A new tree with all components enabled/disabled.

asDisabled

@Nonnull
@CheckReturnValue
default MessageComponentTree 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<MessageTopLevelComponentUnion>

Returns:

A new tree with all components disabled.

asEnabled

@Nonnull
@CheckReturnValue
default MessageComponentTree 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<MessageTopLevelComponentUnion>

Returns:

A new tree with all components enabled.

of

@Nonnull
static MessageComponentTree of(@Nonnull
 Collection<? extends MessageTopLevelComponent> components)

Creates a MessageComponentTree from the given top-level message components.

Parameters:

components - List of components to construct the tree from

Returns:

A MessageComponentTree containing the given components

Throws:

IllegalArgumentException - If null is provided

of

@Nonnull
static MessageComponentTree of(@Nonnull
 MessageTopLevelComponent... components)

Creates a MessageComponentTree from the given top-level message components.

Parameters:

components - List of components to construct the tree from

Returns:

A MessageComponentTree containing the given components

Throws:

IllegalArgumentException - If null is provided