SPIGOT-2540: Add nullability annotations to entire Bukkit API

By: Darkyenus <darkyenus@gmail.com>
This commit is contained in:
Bukkit/Spigot
2019-03-13 17:42:57 +11:00
parent e069a80fd8
commit 416c865476
565 changed files with 5372 additions and 2008 deletions

View File

@@ -3,6 +3,7 @@ package org.bukkit.event.vehicle;
import org.bukkit.block.Block;
import org.bukkit.entity.Vehicle;
import org.bukkit.event.HandlerList;
import org.jetbrains.annotations.NotNull;
/**
* Raised when a vehicle collides with a block.
@@ -11,7 +12,7 @@ public class VehicleBlockCollisionEvent extends VehicleCollisionEvent {
private static final HandlerList handlers = new HandlerList();
private final Block block;
public VehicleBlockCollisionEvent(final Vehicle vehicle, final Block block) {
public VehicleBlockCollisionEvent(@NotNull final Vehicle vehicle, @NotNull final Block block) {
super(vehicle);
this.block = block;
}
@@ -21,15 +22,18 @@ public class VehicleBlockCollisionEvent extends VehicleCollisionEvent {
*
* @return the block the vehicle collided with
*/
@NotNull
public Block getBlock() {
return block;
}
@NotNull
@Override
public HandlerList getHandlers() {
return handlers;
}
@NotNull
public static HandlerList getHandlerList() {
return handlers;
}

View File

@@ -1,12 +1,13 @@
package org.bukkit.event.vehicle;
import org.bukkit.entity.Vehicle;
import org.jetbrains.annotations.NotNull;
/**
* Raised when a vehicle collides.
*/
public abstract class VehicleCollisionEvent extends VehicleEvent {
public VehicleCollisionEvent(final Vehicle vehicle) {
public VehicleCollisionEvent(@NotNull final Vehicle vehicle) {
super(vehicle);
}
}

View File

@@ -3,6 +3,7 @@ package org.bukkit.event.vehicle;
import org.bukkit.entity.Vehicle;
import org.bukkit.event.Cancellable;
import org.bukkit.event.HandlerList;
import org.jetbrains.annotations.NotNull;
/**
* Raised when a vehicle is created.
@@ -11,7 +12,7 @@ public class VehicleCreateEvent extends VehicleEvent implements Cancellable {
private static final HandlerList handlers = new HandlerList();
private boolean cancelled;
public VehicleCreateEvent(final Vehicle vehicle) {
public VehicleCreateEvent(@NotNull final Vehicle vehicle) {
super(vehicle);
}
@@ -25,11 +26,13 @@ public class VehicleCreateEvent extends VehicleEvent implements Cancellable {
this.cancelled = cancelled;
}
@NotNull
@Override
public HandlerList getHandlers() {
return handlers;
}
@NotNull
public static HandlerList getHandlerList() {
return handlers;
}

View File

@@ -4,6 +4,8 @@ import org.bukkit.entity.Entity;
import org.bukkit.entity.Vehicle;
import org.bukkit.event.Cancellable;
import org.bukkit.event.HandlerList;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* Raised when a vehicle receives damage.
@@ -14,7 +16,7 @@ public class VehicleDamageEvent extends VehicleEvent implements Cancellable {
private double damage;
private boolean cancelled;
public VehicleDamageEvent(final Vehicle vehicle, final Entity attacker, final double damage) {
public VehicleDamageEvent(@NotNull final Vehicle vehicle, @Nullable final Entity attacker, final double damage) {
super(vehicle);
this.attacker = attacker;
this.damage = damage;
@@ -25,6 +27,7 @@ public class VehicleDamageEvent extends VehicleEvent implements Cancellable {
*
* @return the Entity that is attacking the vehicle
*/
@Nullable
public Entity getAttacker() {
return attacker;
}
@@ -55,11 +58,13 @@ public class VehicleDamageEvent extends VehicleEvent implements Cancellable {
this.cancelled = cancel;
}
@NotNull
@Override
public HandlerList getHandlers() {
return handlers;
}
@NotNull
public static HandlerList getHandlerList() {
return handlers;
}

View File

@@ -4,6 +4,8 @@ import org.bukkit.entity.Entity;
import org.bukkit.entity.Vehicle;
import org.bukkit.event.Cancellable;
import org.bukkit.event.HandlerList;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* Raised when a vehicle is destroyed, which could be caused by either a
@@ -15,7 +17,7 @@ public class VehicleDestroyEvent extends VehicleEvent implements Cancellable {
private final Entity attacker;
private boolean cancelled;
public VehicleDestroyEvent(final Vehicle vehicle, final Entity attacker) {
public VehicleDestroyEvent(@NotNull final Vehicle vehicle, @Nullable final Entity attacker) {
super(vehicle);
this.attacker = attacker;
}
@@ -25,6 +27,7 @@ public class VehicleDestroyEvent extends VehicleEvent implements Cancellable {
*
* @return the Entity that has destroyed the vehicle, potentially null
*/
@Nullable
public Entity getAttacker() {
return attacker;
}
@@ -37,11 +40,13 @@ public class VehicleDestroyEvent extends VehicleEvent implements Cancellable {
this.cancelled = cancel;
}
@NotNull
@Override
public HandlerList getHandlers() {
return handlers;
}
@NotNull
public static HandlerList getHandlerList() {
return handlers;
}

View File

@@ -4,6 +4,7 @@ import org.bukkit.entity.Entity;
import org.bukkit.entity.Vehicle;
import org.bukkit.event.Cancellable;
import org.bukkit.event.HandlerList;
import org.jetbrains.annotations.NotNull;
/**
* Raised when an entity enters a vehicle.
@@ -13,7 +14,7 @@ public class VehicleEnterEvent extends VehicleEvent implements Cancellable {
private boolean cancelled;
private final Entity entered;
public VehicleEnterEvent(final Vehicle vehicle, final Entity entered) {
public VehicleEnterEvent(@NotNull final Vehicle vehicle, @NotNull final Entity entered) {
super(vehicle);
this.entered = entered;
}
@@ -23,6 +24,7 @@ public class VehicleEnterEvent extends VehicleEvent implements Cancellable {
*
* @return the Entity that entered the vehicle
*/
@NotNull
public Entity getEntered() {
return entered;
}
@@ -35,11 +37,13 @@ public class VehicleEnterEvent extends VehicleEvent implements Cancellable {
this.cancelled = cancel;
}
@NotNull
@Override
public HandlerList getHandlers() {
return handlers;
}
@NotNull
public static HandlerList getHandlerList() {
return handlers;
}

View File

@@ -4,6 +4,7 @@ import org.bukkit.entity.Entity;
import org.bukkit.entity.Vehicle;
import org.bukkit.event.Cancellable;
import org.bukkit.event.HandlerList;
import org.jetbrains.annotations.NotNull;
/**
* Raised when a vehicle collides with an entity.
@@ -15,11 +16,12 @@ public class VehicleEntityCollisionEvent extends VehicleCollisionEvent implement
private boolean cancelledPickup = false;
private boolean cancelledCollision = false;
public VehicleEntityCollisionEvent(final Vehicle vehicle, final Entity entity) {
public VehicleEntityCollisionEvent(@NotNull final Vehicle vehicle, @NotNull final Entity entity) {
super(vehicle);
this.entity = entity;
}
@NotNull
public Entity getEntity() {
return entity;
}
@@ -48,11 +50,13 @@ public class VehicleEntityCollisionEvent extends VehicleCollisionEvent implement
cancelledCollision = cancel;
}
@NotNull
@Override
public HandlerList getHandlers() {
return handlers;
}
@NotNull
public static HandlerList getHandlerList() {
return handlers;
}

View File

@@ -2,6 +2,7 @@ package org.bukkit.event.vehicle;
import org.bukkit.entity.Vehicle;
import org.bukkit.event.Event;
import org.jetbrains.annotations.NotNull;
/**
* Represents a vehicle-related event.
@@ -9,7 +10,7 @@ import org.bukkit.event.Event;
public abstract class VehicleEvent extends Event {
protected Vehicle vehicle;
public VehicleEvent(final Vehicle vehicle) {
public VehicleEvent(@NotNull final Vehicle vehicle) {
this.vehicle = vehicle;
}
@@ -18,6 +19,7 @@ public abstract class VehicleEvent extends Event {
*
* @return the vehicle
*/
@NotNull
public final Vehicle getVehicle() {
return vehicle;
}

View File

@@ -4,6 +4,7 @@ import org.bukkit.entity.LivingEntity;
import org.bukkit.entity.Vehicle;
import org.bukkit.event.Cancellable;
import org.bukkit.event.HandlerList;
import org.jetbrains.annotations.NotNull;
/**
* Raised when a living entity exits a vehicle.
@@ -13,7 +14,7 @@ public class VehicleExitEvent extends VehicleEvent implements Cancellable {
private boolean cancelled;
private final LivingEntity exited;
public VehicleExitEvent(final Vehicle vehicle, final LivingEntity exited) {
public VehicleExitEvent(@NotNull final Vehicle vehicle, @NotNull final LivingEntity exited) {
super(vehicle);
this.exited = exited;
}
@@ -23,6 +24,7 @@ public class VehicleExitEvent extends VehicleEvent implements Cancellable {
*
* @return The entity.
*/
@NotNull
public LivingEntity getExited() {
return exited;
}
@@ -35,11 +37,13 @@ public class VehicleExitEvent extends VehicleEvent implements Cancellable {
this.cancelled = cancel;
}
@NotNull
@Override
public HandlerList getHandlers() {
return handlers;
}
@NotNull
public static HandlerList getHandlerList() {
return handlers;
}

View File

@@ -3,6 +3,7 @@ package org.bukkit.event.vehicle;
import org.bukkit.Location;
import org.bukkit.entity.Vehicle;
import org.bukkit.event.HandlerList;
import org.jetbrains.annotations.NotNull;
/**
* Raised when a vehicle moves.
@@ -12,7 +13,7 @@ public class VehicleMoveEvent extends VehicleEvent {
private final Location from;
private final Location to;
public VehicleMoveEvent(final Vehicle vehicle, final Location from, final Location to) {
public VehicleMoveEvent(@NotNull final Vehicle vehicle, @NotNull final Location from, @NotNull final Location to) {
super(vehicle);
this.from = from;
@@ -24,6 +25,7 @@ public class VehicleMoveEvent extends VehicleEvent {
*
* @return Old position.
*/
@NotNull
public Location getFrom() {
return from;
}
@@ -33,16 +35,19 @@ public class VehicleMoveEvent extends VehicleEvent {
*
* @return New position.
*/
@NotNull
public Location getTo() {
return to;
}
@NotNull
@Override
public HandlerList getHandlers() {
return handlers;
}
@NotNull
public static HandlerList getHandlerList() {
return handlers;
}

View File

@@ -2,6 +2,7 @@ package org.bukkit.event.vehicle;
import org.bukkit.entity.Vehicle;
import org.bukkit.event.HandlerList;
import org.jetbrains.annotations.NotNull;
/**
* Called when a vehicle updates
@@ -9,15 +10,17 @@ import org.bukkit.event.HandlerList;
public class VehicleUpdateEvent extends VehicleEvent {
private static final HandlerList handlers = new HandlerList();
public VehicleUpdateEvent(final Vehicle vehicle) {
public VehicleUpdateEvent(@NotNull final Vehicle vehicle) {
super(vehicle);
}
@NotNull
@Override
public HandlerList getHandlers() {
return handlers;
}
@NotNull
public static HandlerList getHandlerList() {
return handlers;
}