Package net.dv8tion.jda.internal.components.separator

Class SeparatorImpl

java.lang.Object

net.dv8tion.jda.internal.components.AbstractComponentImpl

net.dv8tion.jda.internal.components.separator.SeparatorImpl

All Implemented Interfaces:

Component, ContainerChildComponent, ContainerChildComponentUnion, IComponentUnion, MessageTopLevelComponent, MessageTopLevelComponentUnion, Separator, SerializableData

public class SeparatorImpl
extends AbstractComponentImpl
implements Separator, MessageTopLevelComponentUnion, ContainerChildComponentUnion

Nested Class Summary

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

Component.Type

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.components.separator.Separator

Separator.Spacing

Constructor Summary

Constructors

Constructor	Description
SeparatorImpl(Separator.Spacing spacing, boolean isDivider)
SeparatorImpl(DataObject obj)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Separator.Spacing	getSpacing()	The spacing of this separator.
Component.Type	getType()	The type of component.
int	getUniqueId()	The unique, numeric identifier of this component.
int	hashCode()
boolean	isDivider()	Whether this separator is visible or not.
DataObject	toData()	Serialized DataObject for this object.
String	toString()
Separator	withDivider(boolean divider)	Creates a new Separator with the provided divider status.
Separator	withSpacing(Separator.Spacing spacing)	Creates a new Separator with the provided spacing.
SeparatorImpl	withUniqueId(int uniqueId)	Creates a new component with the provided numeric ID.

Methods inherited from class net.dv8tion.jda.internal.components.AbstractComponentImpl

asActionRow, asButton, asContainer, asEntitySelectMenu, asFileDisplay, asMediaGallery, asSection, asSeparator, asStringSelectMenu, asTextDisplay, asTextInput, asThumbnail

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.components.Component

isMessageCompatible, isModalCompatible

Methods inherited from interface net.dv8tion.jda.api.components.container.ContainerChildComponentUnion

asActionRow, asFileDisplay, asMediaGallery, asSection, asSeparator, asTextDisplay

Methods inherited from interface net.dv8tion.jda.api.components.IComponentUnion

isUnknownComponent

Methods inherited from interface net.dv8tion.jda.api.components.MessageTopLevelComponentUnion

asActionRow, asContainer, asFileDisplay, asMediaGallery, asSection, asSeparator, asTextDisplay

Constructor Details

SeparatorImpl

public SeparatorImpl(DataObject obj)

SeparatorImpl

public SeparatorImpl(Separator.Spacing spacing,
 boolean isDivider)

Method Details

getType

@Nonnull
public Component.Type getType()

Description copied from interface: Component

The type of component.

Specified by:

getType in interface Component

Returns:

Component.Type

withUniqueId

@Nonnull
public SeparatorImpl withUniqueId(int uniqueId)

Description copied from interface: Component

Creates a new component with the provided numeric ID.
If no ID is set, Discord will generate IDs incrementally starting from 1 and will not use existing IDs from the same message/modal.

Specified by:

withUniqueId in interface Component

Specified by:

withUniqueId in interface ContainerChildComponent

Specified by:

withUniqueId in interface ContainerChildComponentUnion

Specified by:

withUniqueId in interface IComponentUnion

Specified by:

withUniqueId in interface MessageTopLevelComponent

Specified by:

withUniqueId in interface MessageTopLevelComponentUnion

Specified by:

withUniqueId in interface Separator

Parameters:

uniqueId - The new ID; must be higher or equal to 1

Returns:

The new component

withDivider

@Nonnull
public Separator withDivider(boolean divider)

Description copied from interface: Separator

Creates a new Separator with the provided divider status.

Specified by:

withDivider in interface Separator

Parameters:

divider - The new divider status, true to make it visible, false is invisible

Returns:

The new Separator

withSpacing

@Nonnull
public Separator withSpacing(@Nonnull
 Separator.Spacing spacing)

Description copied from interface: Separator

Creates a new Separator with the provided spacing.

Specified by:

withSpacing in interface Separator

Parameters:

spacing - The new spacing

Returns:

The new Separator

getUniqueId

public int getUniqueId()

Description copied from interface: Component

The unique, numeric identifier of this component.
Can be set manually or automatically assigned by Discord (starting from 1). If it has not been assigned yet, this will return -1.

Note: Older messages may return 0.

Specified by:

getUniqueId in interface Component

Returns:

The unique identifier of this component, or -1 if not assigned yet, or 0 on older messages

isDivider

public boolean isDivider()

Description copied from interface: Separator

Whether this separator is visible or not.

Specified by:

isDivider in interface Separator

Returns:

true if this separate is a divider, and thus visible, false otherwise

getSpacing

@Nonnull
public Separator.Spacing getSpacing()

Description copied from interface: Separator

The spacing of this separator.

Specified by:

getSpacing in interface Separator

Returns:

The spacing

toData

@Nonnull
public DataObject toData()

Description copied from interface: SerializableData

Serialized DataObject for this object.

Specified by:

toData in interface SerializableData

Returns:

DataObject

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object