接口 MetadataStore<T>
public interface MetadataStore<T>
-
方法概要
修饰符和类型方法说明getMetadata(T subject, @NotNull String metadataKey) 返回附加到对象的所有元数据值.booleanhasMetadata(T subject, @NotNull String metadataKey) 测试对象上是否设置了元数据属性.voidinvalidateAll(@NotNull Plugin owningPlugin) 使元数据存储中来自给定插件的所有元数据无效.void从主体中移除插件拥有的元数据项.voidsetMetadata(T subject, @NotNull String metadataKey, @NotNull MetadataValue newMetadataValue) 向对象添加元数据值.
-
方法详细资料
-
setMetadata
void setMetadata(@NotNull T subject, @NotNull @NotNull String metadataKey, @NotNull @NotNull MetadataValue newMetadataValue) 向对象添加元数据值.原文: Adds a metadata value to an object.
- 参数:
subject- 接收元数据的对象.metadataKey- 用于标识此元数据的唯一键.newMetadataValue- 要应用的元数据值.- 抛出:
IllegalArgumentException- 如果值为null, 或拥有插件为null
-
getMetadata
@NotNull @NotNull List<MetadataValue> getMetadata(@NotNull T subject, @NotNull @NotNull String metadataKey) 返回附加到对象的所有元数据值. 如果多个插件附加了元数据, 每个值都将被包含.原文: Returns all metadata values attached to an object. If multiple plugins have attached metadata, each will value will be included.
- 参数:
subject- 正在查询的对象.metadataKey- 正在查找的唯一元数据键.- 返回:
- 值列表, 每个设置了请求值的插件一个.
-
hasMetadata
测试对象上是否设置了元数据属性.原文: Tests to see if a metadata attribute has been set on an object.
- 参数:
subject- 执行has-metadata测试的对象.metadataKey- 正在查询的唯一元数据键.- 返回:
- metadataKey在主体中的存在性.
-
removeMetadata
void removeMetadata(@NotNull T subject, @NotNull @NotNull String metadataKey, @NotNull @NotNull Plugin owningPlugin) 从主体中移除插件拥有的元数据项.原文: Removes a metadata item owned by a plugin from a subject.
- 参数:
subject- 要从中移除元数据的对象.metadataKey- 标识要移除元数据的唯一元数据键.owningPlugin- 尝试移除元数据项的插件.- 抛出:
IllegalArgumentException- 如果插件为null
-
invalidateAll
使元数据存储中来自给定插件的所有元数据无效. 这将强制每个无效的元数据项在下次访问时重新计算.原文: Invalidates all metadata in the metadata store that originates from the given plugin. Doing this will force each invalidated metadata item to be recalculated the next time it is accessed.
- 参数:
owningPlugin- 请求无效化的插件.- 抛出:
IllegalArgumentException- 如果插件为null
-