Package me.deecaad.core.file

Interface InlineSerializer<T>

All Superinterfaces:

net.kyori.adventure.key.Keyed, org.bukkit.Keyed, Serializer<T>

All Known Implementing Classes:

ActionBarMechanic, ActivateBlockMechanic, BiomeCondition, BossBarMechanic, CommandMechanic, Condition, CustomSoundMechanic, DamageMechanic, DropItemMechanic, EntityTypeCondition, FireworkMechanic, FireworkMechanic.FireworkData, GlidingCondition, HasPermissionCondition, IgniteMechanic, InConeCondition, LeapMechanic, LightLevelCondition, LightningMechanic, MaterialCategoryCondition, Mechanic, MessageMechanic, OnGroundCondition, PlayerEffectMechanic, PlayerEffectMechanicList, PotionMechanic, PushMechanic, RangeCondition, RelativeTargeter, RidingCondition, ScatterTargeter, SculkBloomMechanic, SculkShriekMechanic, ServerPlayersTargeter, ShapeTargeter, SneakingCondition, SoundMechanic, SourceTargeter, SprintingCondition, Targeter, TargetTargeter, TitleMechanic, WorldPlayersTargeter, WorldTargeter

public interface InlineSerializer<T>
extends org.bukkit.Keyed, Serializer<T>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	InlineSerializer.FormatException	This exception is used whenever the user inputs an improperly formatted string.

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	NAME_FINDER
static final String	UNIQUE_IDENTIFIER

Method Summary

Modifier and Type	Method	Description
default String	getInlineKeyword()	Reformats the Upper_Snake_Case YAML config key to UpperCamelCase inline key.
@NotNull org.bukkit.NamespacedKey	getKey()
default @Nullable String	getKeyword()	Returns the unique identifier to this serializer.
static Map<String,MapConfigLike.Holder>	inlineFormat(String line)
static List<MapConfigLike.Holder>	listify(String line, int offset)
static Map<String,MapConfigLike.Holder>	mapify(String line, int offset)
default boolean	shouldSerialize(@NotNull me.deecaad.core.file.SerializeData data)	After the Serializer.getKeyword() check and Serializer.getParentKeywords() check, this final check can be customized by the serializer in order to "fine tune" when a serializer should be automatically serialized.

Methods inherited from interface org.bukkit.Keyed

key

Methods inherited from interface me.deecaad.core.file.Serializer

canUsePathTo, getName, getParentKeywords, getWikiLink, letPassThrough, serialize, tryPathTo, useLater

Field Details

NAME_FINDER

static final Pattern NAME_FINDER

UNIQUE_IDENTIFIER

static final String UNIQUE_IDENTIFIER

See Also:

• Constant Field Values

Method Details

shouldSerialize

default boolean shouldSerialize(@NotNull
 @NotNull me.deecaad.core.file.SerializeData data)

Description copied from interface: Serializer

After the Serializer.getKeyword() check and Serializer.getParentKeywords() check, this final check can be customized by the serializer in order to "fine tune" when a serializer should be automatically serialized.

Specified by:

shouldSerialize in interface Serializer<T>

Parameters:

data - The config information.

Returns:

true if the serializer should serialize.

getKeyword

@Nullable
default @Nullable String getKeyword()

Description copied from interface: Serializer

Returns the unique identifier to this serializer. This identifier is used to determine when to apply the serializer to a config section. The identifier is case-sensitive, and it is ignored when null.

Generally speaking, you should always override this method. When you do not need automatic serializer handling, you may return null.

Specified by:

getKeyword in interface Serializer<T>

Returns:

The nullable unique identifier.

getKey

@NotNull
@NotNull org.bukkit.NamespacedKey getKey()

Specified by:

getKey in interface org.bukkit.Keyed

getInlineKeyword

default String getInlineKeyword()

Reformats the Upper_Snake_Case YAML config key to UpperCamelCase inline key. This helps make inline serialization less sensitive to errors.

Returns:

The non-null lowerCamelCase keyword.

inlineFormat

static Map<String,MapConfigLike.Holder> inlineFormat(String line)
                                              throws InlineSerializer.FormatException

Throws:

InlineSerializer.FormatException

mapify

static Map<String,MapConfigLike.Holder> mapify(String line,
 int offset)
                                        throws InlineSerializer.FormatException

Throws:

InlineSerializer.FormatException

listify

static List<MapConfigLike.Holder> listify(String line,
 int offset)
                                   throws InlineSerializer.FormatException

Throws:

InlineSerializer.FormatException