Package net.kyori.adventure.text

Interface ComponentLike

All Known Subinterfaces:

BlockNBTComponent, BlockNBTComponent.Builder, BuildableComponent<C,B>, Component, ComponentBuilder<C,B>, EntityNBTComponent, EntityNBTComponent.Builder, KeybindComponent, KeybindComponent.Builder, NBTComponent<C,B>, NBTComponentBuilder<C,B>, ScopedComponent<C>, ScoreComponent, ScoreComponent.Builder, SelectorComponent, SelectorComponent.Builder, StorageNBTComponent, StorageNBTComponent.Builder, TextComponent, TextComponent.Builder, TranslatableComponent, TranslatableComponent.Builder

All Known Implementing Classes:

AbstractComponent

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ComponentLike

Something that can be represented as a Component.

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
@NotNull Component	asComponent()	Gets a Component representation.
static @NotNull java.util.List<Component>	asComponents(@NotNull java.util.List<? extends ComponentLike> likes)	Converts a list of ComponentLikes to a list of Components.
static @NotNull java.util.List<Component>	asComponents(@NotNull java.util.List<? extends ComponentLike> likes, @Nullable java.util.function.Predicate<? super Component> filter)	Converts a list of ComponentLikes to a list of Components.
static @Nullable Component	unbox(@Nullable ComponentLike like)	Fetches a Component from a ComponentLike.

Method Detail

asComponents

@NotNull
static @NotNull java.util.List<Component> asComponents(@NotNull
                                                       @NotNull java.util.List<? extends ComponentLike> likes)

Converts a list of ComponentLikes to a list of Components.

Parameters:

likes - the component-likes

Returns:

the components

Since:

4.8.0

asComponents

@NotNull
static @NotNull java.util.List<Component> asComponents(@NotNull
                                                       @NotNull java.util.List<? extends ComponentLike> likes,
                                                       @Nullable
                                                       @Nullable java.util.function.Predicate<? super Component> filter)

Converts a list of ComponentLikes to a list of Components.

Only components that match filter will be returned.

Parameters:

likes - the component-likes

filter - the component filter

Returns:

the components

Since:

4.8.0

unbox

@Nullable
static @Nullable Component unbox(@Nullable
                                 @Nullable ComponentLike like)

Fetches a Component from a ComponentLike.

Parameters:

like - the component-like

Returns:

a component, or null

Since:

4.8.0

asComponent

@Contract(pure=true)
@NotNull
@NotNull Component asComponent()

Gets a Component representation.

Returns:

a component

Since:

4.0.0