Package co.crystaldev.alpinecore.framework.config.object

Class ConfigMessage

java.lang.Object

co.crystaldev.alpinecore.framework.config.object.ConfigMessage

public class ConfigMessage
extends Object

A simple implementation of a configurable plugin message compatible with AlpineConfig.

Utilizes the Adventure framework for formatting.

Since:

0.1.0

See Also:

• Adventure Documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConfigMessage.Serializer

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	message

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConfigMessage(@NotNull String message)
protected	ConfigMessage(@NotNull List<String> message)

Method Summary

Modifier and Type	Method	Description
@NotNull net.kyori.adventure.text.Component	build(@NotNull AlpinePlugin plugin, @NotNull Object... placeholders)	Formats the text of this message with placeholders, then deserializes it using Adventure's MiniMessage.
@NotNull net.kyori.adventure.text.Component	build(@NotNull AlpinePlugin plugin, @NotNull Map<String,Object> placeholders)	Formats the text of this message with placeholders, then deserializes it using Adventure's MiniMessage.
@NotNull String	buildString(@NotNull AlpinePlugin plugin, @NotNull Object... placeholders)	Formats the text of this message with placeholders
@NotNull String	buildString(@NotNull AlpinePlugin plugin, @NotNull Map<String,Object> placeholders)	Formats the text of this message with placeholders
static @NotNull ConfigMessage	of(@NotNull String component)
static @NotNull ConfigMessage	of(@NotNull String... components)

Methods inherited from class java.lang.Object

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

Field Details

message

protected List<String> message

Constructor Details

ConfigMessage

protected ConfigMessage(@NotNull
 @NotNull List<String> message)

ConfigMessage

protected ConfigMessage(@NotNull
 @NotNull String message)

Method Details

of

@NotNull
public static @NotNull ConfigMessage of(@NotNull
 @NotNull String component)

of

@NotNull
public static @NotNull ConfigMessage of(@NotNull
 @NotNull String... components)

build

@NotNull
public @NotNull net.kyori.adventure.text.Component build(@NotNull
 @NotNull AlpinePlugin plugin,
 @NotNull
 @NotNull Object... placeholders)

Formats the text of this message with placeholders, then deserializes it using Adventure's MiniMessage.

Components should be used to send the result of this method.

Parameters:

placeholders - The placeholders for formatting the message

Returns:

The Component

See Also:

• Components
• MiniMessage

build

@NotNull
public @NotNull net.kyori.adventure.text.Component build(@NotNull
 @NotNull AlpinePlugin plugin,
 @NotNull
 @NotNull Map<String,Object> placeholders)

Formats the text of this message with placeholders, then deserializes it using Adventure's MiniMessage.

Components should be used to send the result of this method.

Parameters:

placeholders - The placeholders for formatting the message

Returns:

The Component

See Also:

• Components
• MiniMessage

buildString

@NotNull
public @NotNull String buildString(@NotNull
 @NotNull AlpinePlugin plugin,
 @NotNull
 @NotNull Object... placeholders)

Formats the text of this message with placeholders

Parameters:

placeholders - The placeholders for formatting the message

Returns:

The string

buildString

@NotNull
public @NotNull String buildString(@NotNull
 @NotNull AlpinePlugin plugin,
 @NotNull
 @NotNull Map<String,Object> placeholders)

Formats the text of this message with placeholders

Parameters:

placeholders - The placeholders for formatting the message

Returns:

The string