cc.carm.lib.mineconfiguration.bukkit.value.notify

类 NotifyType<M>

java.lang.Object

cc.carm.lib.mineconfiguration.bukkit.value.notify.NotifyType<M>

直接已知子类:

SoundNotify, StringNotify, TitleNotify

public abstract class NotifyType<M>
extends java.lang.Object

字段概要

字段

限定符和类型	字段和说明
protected @NotNull java.lang.String	key
protected @NotNull java.lang.Class<M>	metaClass

构造器概要

构造器

限定符	构造器和说明
protected	NotifyType(@NotNull java.lang.String key, @NotNull java.lang.Class<M> metaClass)

方法概要

限定符和类型	方法和说明
abstract void	execute(@NotNull org.bukkit.entity.Player player, M meta, @NotNull java.util.Map<java.lang.String,java.lang.Object> placeholders) Execute the notify content to specific player.
@NotNull java.lang.String	getKey()
@NotNull java.lang.Class<M>	getMetaClass()
abstract M	parseMeta(@Nullable java.lang.String param, @Nullable java.lang.String content) Parse metadata from string.
abstract @NotNull java.lang.String	serializeConfig(M meta) Serialize the metadata to singleton string to storage on configs.
protected java.lang.String	setPlaceholders(@NotNull org.bukkit.entity.Player player, @Nullable java.lang.String content, @NotNull java.util.Map<java.lang.String,java.lang.Object> placeholders)

从类继承的方法 java.lang.Object

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

字段详细资料

key

@NotNull
protected final @NotNull java.lang.String key

metaClass

@NotNull
protected final @NotNull java.lang.Class<M> metaClass

构造器详细资料

NotifyType

protected NotifyType(@NotNull
                     @NotNull java.lang.String key,
                     @NotNull
                     @NotNull java.lang.Class<M> metaClass)

方法详细资料

getKey

@NotNull
public @NotNull java.lang.String getKey()

getMetaClass

@NotNull
public @NotNull java.lang.Class<M> getMetaClass()

parseMeta

@Nullable
public abstract M parseMeta(@Nullable
                                      @Nullable java.lang.String param,
                                      @Nullable
                                      @Nullable java.lang.String content)

Parse metadata from string.
e.g. "[TYPE-KEY@PARAM] CONTENTS..."

参数:

param - The param of the notify config.

content - The content of the notify config.

返回:

The parsed metadata.

serializeConfig

@NotNull
public abstract @NotNull java.lang.String serializeConfig(@Nullable
                                                                   M meta)

Serialize the metadata to singleton string to storage on configs.

参数:

meta - The parsed metadata.

返回:

The serialized string.

execute

public abstract void execute(@NotNull
                             @NotNull org.bukkit.entity.Player player,
                             @Nullable
                             M meta,
                             @NotNull
                             @NotNull java.util.Map<java.lang.String,java.lang.Object> placeholders)

Execute the notify content to specific player.

参数:

player - The player who receive the notification.

meta - The parsed metadata.

setPlaceholders

@Contract(value="_, _, null -> null; _, _, !null -> !null")
protected java.lang.String setPlaceholders(@NotNull
                                                                                                       @NotNull org.bukkit.entity.Player player,
                                                                                                       @Nullable
                                                                                                       @Nullable java.lang.String content,
                                                                                                       @NotNull
                                                                                                       @NotNull java.util.Map<java.lang.String,java.lang.Object> placeholders)