twin/paper-mc
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-08-14 03:35:51 -07:00
Code Issues Packages Projects Releases Wiki Activity

Javadoc improvements per checkstyle

Browse Source 
By: md_5 <git@md-5.net>
This commit is contained in:
Bukkit/Spigot
2019-12-22 09:56:28 +11:00
parent d419ccca3f
commit d16413b877
96 changed files with 181 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
paper-api/src/main/java/org/bukkit/metadata/MetadataStoreBase.java
View File

@@ -32,9 +32,9 @@ public abstract class MetadataStoreBase<T> {
* @param subject The object receiving the metadata.
* @param metadataKey A unique key to identify this metadata.
* @param newMetadataValue The metadata value to apply.
* @see MetadataStore#setMetadata(Object, String, MetadataValue)
* @throws IllegalArgumentException If value is null, or the owning plugin
* is null
* @see MetadataStore#setMetadata(Object, String, MetadataValue)
*/
public synchronized void setMetadata(@NotNull T subject, @NotNull String metadataKey, @NotNull MetadataValue newMetadataValue) {
Validate.notNull(newMetadataValue, "Value cannot be null");
@@ -90,9 +90,9 @@ public abstract class MetadataStoreBase<T> {
* @param metadataKey the unique metadata key identifying the metadata to
* remove.
* @param owningPlugin the plugin attempting to remove a metadata item.
* @throws IllegalArgumentException If plugin is null
* @see MetadataStore#removeMetadata(Object, String,
* org.bukkit.plugin.Plugin)
* @throws IllegalArgumentException If plugin is null
*/
public synchronized void removeMetadata(@NotNull T subject, @NotNull String metadataKey, @NotNull Plugin owningPlugin) {
Validate.notNull(owningPlugin, "Plugin cannot be null");
@@ -114,8 +114,8 @@ public abstract class MetadataStoreBase<T> {
* be recalculated the next time it is accessed.
*
* @param owningPlugin the plugin requesting the invalidation.
* @see MetadataStore#invalidateAll(org.bukkit.plugin.Plugin)
* @throws IllegalArgumentException If plugin is null
* @see MetadataStore#invalidateAll(org.bukkit.plugin.Plugin)
*/
public synchronized void invalidateAll(@NotNull Plugin owningPlugin) {
Validate.notNull(owningPlugin, "Plugin cannot be null");

6
paper-api/src/main/java/org/bukkit/metadata/package-info.java Normal file
View File

@@ -0,0 +1,6 @@
/**
* Classes dedicated to providing a layer of plugin specified data on various
* Minecraft concepts.
*/
package org.bukkit.metadata;