Class Components

java.lang.Object

net.dv8tion.jda.api.components.Components

public class Components
extends Object

Utility class for components.

This utility builds on ComponentDeserializer to deserialize components. The implementation provided by ComponentDeserializer allows to deserialize components with implicit FileUploads like Thumbnail.

See Also:

• ComponentDeserializer
• ComponentSerializer

Constructor Summary

Constructors

Constructor	Description
Components()

Method Summary

Modifier and Type	Method	Description
static <T extends Component> T	parseComponent(Class<T> componentType, DataObject data)	Converts the provided DataObject into a component of type T.
static <T extends Component> List<T>	parseComponents(Class<T> componentType, DataArray data)	Converts the provided DataArray into a List of components.
static <T extends ComponentTree<?>> T	parseTree(Class<T> treeType, DataArray data)	Converts the provided DataArray into a ComponentTree.

Methods inherited from class Object

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

Constructor Details

Components

public Components()

Method Details

parseComponent

@Nonnull
public static <T extends Component> T parseComponent(@Nonnull
 Class<T> componentType,
 @Nonnull
 DataObject data)

Converts the provided DataObject into a component of type T.
Note that any unsupported component will be represented as an UnknownComponent.

Parameters:

data - The DataArray to create the component tree from

Returns:

A ComponentTree representing the provided data

Throws:

IllegalArgumentException - If the provided data is null, or the component is not of type T

See Also:

• ComponentDeserializer.deserializeAs(Class, DataObject)

parseComponents

@Nonnull
public static <T extends Component> List<T> parseComponents(@Nonnull
 Class<T> componentType,
 @Nonnull
 DataArray data)

Converts the provided DataArray into a List of components.
Note that any unsupported component will be represented as an UnknownComponent.

Parameters:

data - The DataArray to create the components from

Returns:

A List of T representing the provided data

Throws:

IllegalArgumentException - If the provided data is null, or one of the components is not of type T

See Also:

• ComponentDeserializer.deserializeAs(Class, DataArray)

parseTree

@Nonnull
public static <T extends ComponentTree<?>> T parseTree(@Nonnull
 Class<T> treeType,
 @Nonnull
 DataArray data)

Converts the provided DataArray into a ComponentTree.
Note that any unsupported component will be represented as an UnknownComponent.

Parameters:

data - The DataArray to create the component tree from

Returns:

A ComponentTree representing the provided data

Throws:

IllegalArgumentException - If the provided data is null, or one of the components is not compatible.

UnsupportedOperationException - If the provided tree type is not supported

See Also:

• ComponentDeserializer.deserializeAsTree(Class, DataArray)