Class ComponentSerializer

java.lang.Object

net.dv8tion.jda.api.components.utils.ComponentSerializer

public class ComponentSerializer
extends Object

Utility class to serialize a list of Components into DataObject.

Since some components include implicit file uploads, such as FileDisplay and Thumbnail, the included FileUpload instances can be accessed using getFileUploads(Collection).
Each uploaded file is referenced in the respective components using attachment://filename.

This separation is done to simplify persistence of these components in preferred formats. For instance, you might want to store the components as JSON Blobs but the files in an object storage.

You can use ComponentDeserializer to deserialize the output again, make sure you also provide any implicit FileUpload instances.

See Also:

• ComponentDeserializer

Constructor Summary

Constructors

Constructor	Description
ComponentSerializer()

Method Summary

Modifier and Type	Method	Description
List<FileUpload>	getFileUploads(Collection<? extends Component> components)	Returns the implicit FileUpload instances used by serializeAll(Collection).
List<FileUpload>	getFileUploads(Component component)	Returns the implicit FileUpload instances used by serialize(Component).
DataObject	serialize(Component component)	Serializes the provided component into a DataObject instance.
List<DataObject>	serializeAll(Collection<? extends Component> components)	Serializes the provided components into DataObject instances.

Methods inherited from class Object

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

Constructor Details

ComponentSerializer

public ComponentSerializer()

Method Details

serialize

@Nonnull
public DataObject serialize(@Nonnull
 Component component)

Serializes the provided component into a DataObject instance.

Some components that would implicitly upload a file, for instance Thumbnail, will reference the file using a URI with this format attachment://filename. The filename refers to a FileUpload provided by getFileUploads(Component), with a corresponding name.

Parameters:

component - The component to serialized into DataObject

Returns:

Serialized DataObject for the provided component

Throws:

IllegalArgumentException - If null is provided

serializeAll

@Nonnull
public List<DataObject> serializeAll(@Nonnull
 Collection<? extends Component> components)

Serializes the provided components into DataObject instances.

Some components that would implicitly upload a file, for instance Thumbnail, will reference the file using a URI with this format attachment://filename. The filename refers to a FileUpload provided by getFileUploads(Collection), with a corresponding name.

Parameters:

components - The components to serialized into DataObjects

Returns:

List of DataObject

Throws:

IllegalArgumentException - If null is provided

getFileUploads

@Nonnull
public List<FileUpload> getFileUploads(@Nonnull
 Component component)

Returns the implicit FileUpload instances used by serialize(Component).

Parameters:

component - The component to take the FileUploads from

Returns:

The implicit FileUpload instances for the provided component

Throws:

IllegalArgumentException - If null is provided

getFileUploads

@Nonnull
public List<FileUpload> getFileUploads(@Nonnull
 Collection<? extends Component> components)

Returns the implicit FileUpload instances used by serializeAll(Collection).

Parameters:

components - The components to take the FileUploads from

Returns:

The implicit FileUpload instances for the provided components

Throws:

IllegalArgumentException - If null is provided