Upstream/HolographicDisplays
1
0
Fork 0
mirror of https://github.com/filoghost/HolographicDisplays.git synced 2024-09-28 23:27:31 +02:00
Code Issues Projects Releases Wiki Activity

Annotate overriding methods

Browse Source
This commit is contained in:
filoghost 2021-05-16 21:11:25 +02:00
parent a31f29cb32
commit 949018c60f
14 changed files with 55 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
plugin/src/main/java/me/filoghost/holographicdisplays/DefaultHolographicDisplaysAPI.java
View File

@ -14,6 +14,7 @@ import me.filoghost.holographicdisplays.placeholder.registry.PlaceholderRegistry
import org.bukkit.Bukkit;
import org.bukkit.Location;
import org.bukkit.plugin.Plugin;
import org.jetbrains.annotations.NotNull;
import java.util.Collection;
@ -30,7 +31,7 @@ public class DefaultHolographicDisplaysAPI implements HolographicDisplaysAPI {
}
@Override
public Hologram createHologram(Location source) {
public @NotNull Hologram createHologram(@NotNull Location source) {
Preconditions.notNull(source, "source");
Preconditions.notNull(source.getWorld(), "source's world");
Preconditions.checkState(Bukkit.isPrimaryThread(), "Async hologram creation");
@ -39,7 +40,7 @@ public class DefaultHolographicDisplaysAPI implements HolographicDisplaysAPI {
}
@Override
public void registerPlaceholder(String identifier, int refreshIntervalTicks, PlaceholderReplacer replacer) {
public void registerPlaceholder(@NotNull String identifier, int refreshIntervalTicks, @NotNull PlaceholderReplacer replacer) {
Preconditions.notNull(identifier, "identifier");
Preconditions.checkArgument(refreshIntervalTicks >= 0, "refreshIntervalTicks should be positive");
Preconditions.notNull(replacer, "replacer");
@ -48,24 +49,24 @@ public class DefaultHolographicDisplaysAPI implements HolographicDisplaysAPI {
}
@Override
public boolean isRegisteredPlaceholder(String identifier) {
public boolean isRegisteredPlaceholder(@NotNull String identifier) {
Preconditions.notNull(identifier, "identifier");
return placeholderRegistry.isRegisteredIdentifier(plugin, identifier);
}
@Override
public Collection<Hologram> getHolograms() {
public @NotNull Collection<Hologram> getHolograms() {
return apiHologramManager.getHologramsByPlugin(plugin);
}
@Override
public Collection<String> getRegisteredPlaceholders() {
public @NotNull Collection<String> getRegisteredPlaceholders() {
return placeholderRegistry.getRegisteredIdentifiers(plugin);
}
@Override
public void unregisterPlaceholder(String identifier) {
public void unregisterPlaceholder(@NotNull String identifier) {
Preconditions.notNull(identifier, "identifier");
placeholderRegistry.unregister(plugin, identifier);

3
plugin/src/main/java/me/filoghost/holographicdisplays/legacy/api/v2/NewPickupHandlerAdapter.java
View File

@ -7,6 +7,7 @@ package me.filoghost.holographicdisplays.legacy.api.v2;
import com.gmail.filoghost.holographicdisplays.api.handler.PickupHandler;
import org.bukkit.entity.Player;
import org.jetbrains.annotations.NotNull;
@SuppressWarnings("deprecation")
public class NewPickupHandlerAdapter implements me.filoghost.holographicdisplays.api.handler.PickupHandler {
@ -18,7 +19,7 @@ public class NewPickupHandlerAdapter implements me.filoghost.holographicdisplays
}
@Override
public void onPickup(Player player) {
public void onPickup(@NotNull Player player) {
v2PickupHandler.onPickup(player);
}

3
plugin/src/main/java/me/filoghost/holographicdisplays/legacy/api/v2/NewTouchHandlerAdapter.java
View File

@ -7,6 +7,7 @@ package me.filoghost.holographicdisplays.legacy.api.v2;
import com.gmail.filoghost.holographicdisplays.api.handler.TouchHandler;
import org.bukkit.entity.Player;
import org.jetbrains.annotations.NotNull;
@SuppressWarnings("deprecation")
public class NewTouchHandlerAdapter implements me.filoghost.holographicdisplays.api.handler.TouchHandler {
@ -18,7 +19,7 @@ public class NewTouchHandlerAdapter implements me.filoghost.holographicdisplays.
}
@Override
public void onTouch(Player player) {
public void onTouch(@NotNull Player player) {
v2TouchHandler.onTouch(player);
}

14
plugin/src/main/java/me/filoghost/holographicdisplays/object/api/APIHologram.java
View File

@ -16,6 +16,8 @@ import org.bukkit.Location;
import org.bukkit.entity.Player;
import org.bukkit.inventory.ItemStack;
import org.bukkit.plugin.Plugin;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.List;
@ -45,14 +47,14 @@ public class APIHologram extends BaseHologram<APIHologramLine> implements Hologr
}
@Override
public APITextLine appendTextLine(String text) {
public @NotNull APITextLine appendTextLine(@Nullable String text) {
APITextLine line = createTextLine(text);
addLine(line);
return line;
}
@Override
public APIItemLine appendItemLine(ItemStack itemStack) {
public @NotNull APIItemLine appendItemLine(@NotNull ItemStack itemStack) {
Preconditions.notNull(itemStack, "itemStack");
APIItemLine line = createItemLine(itemStack);
@ -61,14 +63,14 @@ public class APIHologram extends BaseHologram<APIHologramLine> implements Hologr
}
@Override
public APITextLine insertTextLine(int index, String text) {
public @NotNull APITextLine insertTextLine(int index, @Nullable String text) {
APITextLine line = createTextLine(text);
addLine(line);
return line;
}
@Override
public APIItemLine insertItemLine(int index, ItemStack itemStack) {
public @NotNull APIItemLine insertItemLine(int index, @NotNull ItemStack itemStack) {
Preconditions.notNull(itemStack, "itemStack");
APIItemLine line = createItemLine(itemStack);
@ -85,7 +87,7 @@ public class APIHologram extends BaseHologram<APIHologramLine> implements Hologr
}
@Override
public APIHologramLine getLine(int index) {
public @NotNull APIHologramLine getLine(int index) {
return getLines().get(index);
}
@ -132,7 +134,7 @@ public class APIHologram extends BaseHologram<APIHologramLine> implements Hologr
}
@Override
public DefaultVisibilityManager getVisibilityManager() {
public @NotNull DefaultVisibilityManager getVisibilityManager() {
return visibilityManager;
}

3
plugin/src/main/java/me/filoghost/holographicdisplays/object/api/APIHologramLine.java
View File

@ -8,11 +8,12 @@ package me.filoghost.holographicdisplays.object.api;
import me.filoghost.holographicdisplays.api.line.HologramLine;
import me.filoghost.holographicdisplays.core.hologram.StandardHologramLine;
import me.filoghost.holographicdisplays.legacy.api.v2.V2HologramLineAdapter;
import org.jetbrains.annotations.NotNull;
public interface APIHologramLine extends HologramLine, StandardHologramLine {
@Override
APIHologram getParent();
@NotNull APIHologram getParent();
@Override
default void removeLine() {

8
plugin/src/main/java/me/filoghost/holographicdisplays/object/api/APIItemLine.java
View File

@ -6,6 +6,8 @@ import me.filoghost.holographicdisplays.api.line.ItemLine;
import me.filoghost.holographicdisplays.legacy.api.v2.V2ItemLineAdapter;
import me.filoghost.holographicdisplays.object.base.BaseItemLine;
import org.bukkit.inventory.ItemStack;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
public class APIItemLine extends BaseItemLine implements ItemLine, APITouchableLine {
@ -19,18 +21,18 @@ public class APIItemLine extends BaseItemLine implements ItemLine, APITouchableL
}
@Override
public APIHologram getParent() {
public @NotNull APIHologram getParent() {
return parent;
}
@Override
public void setTouchHandler(TouchHandler touchHandler) {
public void setTouchHandler(@Nullable TouchHandler touchHandler) {
v2Adapter.onNewTouchHandlerChange(getTouchHandler(), touchHandler);
super.setTouchHandler(touchHandler);
}
@Override
public void setPickupHandler(PickupHandler pickupHandler) {
public void setPickupHandler(@Nullable PickupHandler pickupHandler) {
v2Adapter.onNewPickupHandlerChange(getPickupHandler(), pickupHandler);
super.setPickupHandler(pickupHandler);
}

6
plugin/src/main/java/me/filoghost/holographicdisplays/object/api/APITextLine.java
View File

@ -4,6 +4,8 @@ import me.filoghost.holographicdisplays.api.handler.TouchHandler;
import me.filoghost.holographicdisplays.api.line.TextLine;
import me.filoghost.holographicdisplays.legacy.api.v2.V2TextLineAdapter;
import me.filoghost.holographicdisplays.object.base.BaseTextLine;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
public class APITextLine extends BaseTextLine implements TextLine, APITouchableLine {
@ -17,7 +19,7 @@ public class APITextLine extends BaseTextLine implements TextLine, APITouchableL
}
@Override
public APIHologram getParent() {
public @NotNull APIHologram getParent() {
return parent;
}
@ -27,7 +29,7 @@ public class APITextLine extends BaseTextLine implements TextLine, APITouchableL
}
@Override
public void setTouchHandler(TouchHandler touchHandler) {
public void setTouchHandler(@Nullable TouchHandler touchHandler) {
v2Adapter.onNewTouchHandlerChange(getTouchHandler(), touchHandler);
super.setTouchHandler(touchHandler);
}

9
plugin/src/main/java/me/filoghost/holographicdisplays/object/api/DefaultVisibilityManager.java
View File

@ -12,6 +12,7 @@ import me.filoghost.holographicdisplays.core.hologram.StandardHologram;
import me.filoghost.holographicdisplays.legacy.api.v2.V2VisibilityManagerAdapter;
import org.bukkit.Bukkit;
import org.bukkit.entity.Player;
import org.jetbrains.annotations.NotNull;
import java.util.HashSet;
import java.util.Map;
@ -63,7 +64,7 @@ public class DefaultVisibilityManager implements VisibilityManager {
}
@Override
public void showTo(Player player) {
public void showTo(@NotNull Player player) {
Preconditions.notNull(player, "player");
boolean wasVisible = isVisibleTo(player);
@ -82,7 +83,7 @@ public class DefaultVisibilityManager implements VisibilityManager {
@Override
public void hideTo(Player player) {
public void hideTo(@NotNull Player player) {
Preconditions.notNull(player, "player");
boolean wasVisible = isVisibleTo(player);
@ -100,7 +101,7 @@ public class DefaultVisibilityManager implements VisibilityManager {
}
@Override
public boolean isVisibleTo(Player player) {
public boolean isVisibleTo(@NotNull Player player) {
Preconditions.notNull(player, "player");
if (playersVisibilityMap != null) {
@ -114,7 +115,7 @@ public class DefaultVisibilityManager implements VisibilityManager {
}
@Override
public void resetVisibility(Player player) {
public void resetVisibility(@NotNull Player player) {
Preconditions.notNull(player, "player");
if (playersVisibilityMap == null) {

5
plugin/src/main/java/me/filoghost/holographicdisplays/object/base/BaseHologram.java
View File

@ -13,6 +13,7 @@ import me.filoghost.holographicdisplays.disk.Configuration;
import me.filoghost.holographicdisplays.placeholder.PlaceholderManager;
import org.bukkit.Location;
import org.bukkit.World;
import org.jetbrains.annotations.NotNull;
import java.util.ArrayList;
import java.util.Collections;
@ -133,13 +134,13 @@ public abstract class BaseHologram<T extends StandardHologramLine> extends BaseH
return lines.size();
}
public void teleport(Location location) {
public void teleport(@NotNull Location location) {
Preconditions.notNull(location, "location");
teleport(location.getWorld(), location.getX(), location.getY(), location.getZ());
}
public void teleport(World world, double x, double y, double z) {
public void teleport(@NotNull World world, double x, double y, double z) {
checkNotDeleted();
Preconditions.notNull(world, "world");

5
plugin/src/main/java/me/filoghost/holographicdisplays/object/base/BaseHologramComponent.java
View File

@ -9,6 +9,7 @@ import me.filoghost.fcommons.Preconditions;
import org.bukkit.Chunk;
import org.bukkit.Location;
import org.bukkit.World;
import org.jetbrains.annotations.NotNull;
public abstract class BaseHologramComponent {
@ -27,7 +28,7 @@ public abstract class BaseHologramComponent {
return world.isChunkLoaded(chunkX, chunkZ);
}
public Location getLocation() {
public @NotNull Location getLocation() {
return new Location(world, x, y, z);
}
@ -51,7 +52,7 @@ public abstract class BaseHologramComponent {
return floor == num ? floor : floor - (int) (Double.doubleToRawLongBits(num) >>> 63);
}
public World getWorld() {
public @NotNull World getWorld() {
return world;
}

10
plugin/src/main/java/me/filoghost/holographicdisplays/object/base/BaseItemLine.java
View File

@ -15,6 +15,8 @@ import me.filoghost.holographicdisplays.core.nms.entity.NMSItem;
import org.bukkit.World;
import org.bukkit.entity.Player;
import org.bukkit.inventory.ItemStack;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Collection;
@ -45,19 +47,19 @@ public abstract class BaseItemLine extends BaseTouchableLine implements Standard
}
}
public PickupHandler getPickupHandler() {
public @Nullable PickupHandler getPickupHandler() {
return pickupHandler;
}
public void setPickupHandler(PickupHandler pickupHandler) {
public void setPickupHandler(@Nullable PickupHandler pickupHandler) {
this.pickupHandler = pickupHandler;
}
public ItemStack getItemStack() {
public @NotNull ItemStack getItemStack() {
return itemStack;
}
public void setItemStack(ItemStack itemStack) {
public void setItemStack(@NotNull ItemStack itemStack) {
Preconditions.notNull(itemStack, "itemStack");
Preconditions.checkArgument(0 < itemStack.getAmount() && itemStack.getAmount() <= 64, "Item must have amount between 1 and 64");
this.itemStack = itemStack;

5
plugin/src/main/java/me/filoghost/holographicdisplays/object/base/BaseTextLine.java
View File

@ -11,6 +11,7 @@ import me.filoghost.holographicdisplays.core.nms.entity.NMSArmorStand;
import me.filoghost.holographicdisplays.core.placeholder.RelativePlaceholder;
import org.bukkit.World;
import org.bukkit.entity.Player;
import org.jetbrains.annotations.Nullable;
import java.util.ArrayList;
import java.util.Collection;
@ -29,11 +30,11 @@ public abstract class BaseTextLine extends BaseTouchableLine implements Standard
}
@Override
public String getText() {
public @Nullable String getText() {
return text;
}
public void setText(String text) {
public void setText(@Nullable String text) {
this.text = text;
if (textEntity != null) {

5
plugin/src/main/java/me/filoghost/holographicdisplays/object/base/BaseTouchableLine.java
View File

@ -14,6 +14,7 @@ import me.filoghost.holographicdisplays.core.nms.entity.NMSArmorStand;
import me.filoghost.holographicdisplays.core.nms.entity.NMSSlime;
import org.bukkit.World;
import org.bukkit.entity.Player;
import org.jetbrains.annotations.Nullable;
import java.util.Collection;
import java.util.Map;
@ -61,7 +62,7 @@ public abstract class BaseTouchableLine extends BaseHologramLine implements Stan
}
}
public void setTouchHandler(TouchHandler touchHandler) {
public void setTouchHandler(@Nullable TouchHandler touchHandler) {
this.touchHandler = touchHandler;
if (touchHandler != null && slimeEntity == null && super.isSpawned()) {
@ -73,7 +74,7 @@ public abstract class BaseTouchableLine extends BaseHologramLine implements Stan
}
}
public TouchHandler getTouchHandler() {
public @Nullable TouchHandler getTouchHandler() {
return this.touchHandler;
}

3
plugin/src/test/java/me/filoghost/holographicdisplays/legacy/api/v2/V2TouchableLineAdapterTest.java
View File

@ -10,6 +10,7 @@ import me.filoghost.holographicdisplays.api.handler.TouchHandler;
import me.filoghost.holographicdisplays.object.api.APIHologram;
import me.filoghost.holographicdisplays.object.api.APITextLine;
import org.bukkit.entity.Player;
import org.jetbrains.annotations.NotNull;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.*;
@ -182,7 +183,7 @@ class V2TouchableLineAdapterTest {
private static class ExampleNewTouchHandler implements TouchHandler {
@Override
public void onTouch(Player player) {}
public void onTouch(@NotNull Player player) {}
}