Skip to content

Commit 318df64

Browse files
authored
Fix Improper Use of Event API (#3853)
* Fix Improper Use of Event API * Checkstyle OOOO
1 parent cb45867 commit 318df64

13 files changed

+130
-23
lines changed

Essentials/src/main/java/net/ess3/api/events/AfkStatusChangeEvent.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
package net.ess3.api.events;
22

33
import net.ess3.api.IUser;
4+
import org.bukkit.event.HandlerList;
45

56
/**
67
* Fired when a player's AFK status changes.
78
*/
89
public class AfkStatusChangeEvent extends StatusChangeEvent {
10+
private static final HandlerList handlers = new HandlerList();
911
private final Cause cause;
1012

1113
@Deprecated
@@ -22,6 +24,15 @@ public Cause getCause() {
2224
return cause;
2325
}
2426

27+
@Override
28+
public HandlerList getHandlers() {
29+
return handlers;
30+
}
31+
32+
public static HandlerList getHandlerList() {
33+
return handlers;
34+
}
35+
2536
/**
2637
* The cause of the AFK status change.
2738
*/
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,24 @@
11
package net.ess3.api.events;
22

33
import net.ess3.api.IUser;
4+
import org.bukkit.event.HandlerList;
45

56
/**
67
* Fired when a player's flight status is toggled using /fly.
78
*/
89
public class FlyStatusChangeEvent extends StatusChangeEvent {
10+
private static final HandlerList handlers = new HandlerList();
11+
912
public FlyStatusChangeEvent(final IUser affected, final IUser controller, final boolean value) {
1013
super(affected, controller, value);
1114
}
15+
16+
@Override
17+
public HandlerList getHandlers() {
18+
return handlers;
19+
}
20+
21+
public static HandlerList getHandlerList() {
22+
return handlers;
23+
}
1224
}

Essentials/src/main/java/net/ess3/api/events/GodStatusChangeEvent.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package net.ess3.api.events;
22

33
import net.ess3.api.IUser;
4+
import org.bukkit.event.HandlerList;
45

56
/**
67
* Fired when a user's god status is toggled.
@@ -9,7 +10,18 @@
910
* and #getController methods are inverted.
1011
*/
1112
public class GodStatusChangeEvent extends StatusChangeEvent {
13+
private static final HandlerList handlers = new HandlerList();
14+
1215
public GodStatusChangeEvent(final IUser affected, final IUser controller, final boolean value) {
1316
super(affected, controller, value);
1417
}
18+
19+
@Override
20+
public HandlerList getHandlers() {
21+
return handlers;
22+
}
23+
24+
public static HandlerList getHandlerList() {
25+
return handlers;
26+
}
1527
}
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,24 @@
11
package net.ess3.api.events;
22

33
import net.ess3.api.IUser;
4+
import org.bukkit.event.HandlerList;
45

56
/**
67
* This event is currently unused, and is retained for ABI compatibility and potential future implementation.
78
*/
89
public class IgnoreStatusChangeEvent extends StatusChangeEvent {
10+
private static final HandlerList handlers = new HandlerList();
11+
912
public IgnoreStatusChangeEvent(final IUser affected, final IUser controller, final boolean value) {
1013
super(affected, controller, value);
1114
}
15+
16+
@Override
17+
public HandlerList getHandlers() {
18+
return handlers;
19+
}
20+
21+
public static HandlerList getHandlerList() {
22+
return handlers;
23+
}
1224
}

Essentials/src/main/java/net/ess3/api/events/JailStatusChangeEvent.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package net.ess3.api.events;
22

33
import net.ess3.api.IUser;
4+
import org.bukkit.event.HandlerList;
45

56
/**
67
* Fired when a player's jail status changes.
@@ -9,7 +10,18 @@
910
* You <i>can</i>, however, access the player's current jail when they are about to be unjailed by calling {@link IUser#getJail()}.
1011
*/
1112
public class JailStatusChangeEvent extends StatusChangeEvent {
13+
private static final HandlerList handlers = new HandlerList();
14+
1215
public JailStatusChangeEvent(final IUser affected, final IUser controller, final boolean value) {
1316
super(affected, controller, value);
1417
}
18+
19+
@Override
20+
public HandlerList getHandlers() {
21+
return handlers;
22+
}
23+
24+
public static HandlerList getHandlerList() {
25+
return handlers;
26+
}
1527
}

Essentials/src/main/java/net/ess3/api/events/MuteStatusChangeEvent.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
package net.ess3.api.events;
22

33
import net.ess3.api.IUser;
4+
import org.bukkit.event.HandlerList;
45

56
import java.util.Optional;
67

78
/**
89
* Fired when a player's mute status is changed.
910
*/
1011
public class MuteStatusChangeEvent extends StatusChangeEvent {
12+
private static final HandlerList handlers = new HandlerList();
1113
private final Long timestamp;
1214
private final String reason;
1315

@@ -30,4 +32,13 @@ public Optional<Long> getTimestamp() {
3032
public String getReason() {
3133
return reason;
3234
}
35+
36+
@Override
37+
public HandlerList getHandlers() {
38+
return handlers;
39+
}
40+
41+
public static HandlerList getHandlerList() {
42+
return handlers;
43+
}
3344
}

Essentials/src/main/java/net/ess3/api/events/NickChangeEvent.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,15 @@
22

33
import net.ess3.api.IUser;
44
import org.bukkit.event.Cancellable;
5+
import org.bukkit.event.HandlerList;
56

67
/**
78
* Fired when a player's nickname is changed.
89
*
910
* <b>WARNING: The values of {@link NickChangeEvent#getAffected()} and {@link NickChangeEvent#getController()} are inverted due to a long-standing implementation bug.</b>
1011
*/
1112
public class NickChangeEvent extends StateChangeEvent implements Cancellable {
13+
private static final HandlerList handlers = new HandlerList();
1214
private final String newValue;
1315

1416
public NickChangeEvent(final IUser affected, final IUser controller, final String value) {
@@ -41,4 +43,13 @@ public IUser getAffected() {
4143
public IUser getController() {
4244
return super.getController();
4345
}
46+
47+
@Override
48+
public HandlerList getHandlers() {
49+
return handlers;
50+
}
51+
52+
public static HandlerList getHandlerList() {
53+
return handlers;
54+
}
4455
}

Essentials/src/main/java/net/ess3/api/events/SignBreakEvent.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,26 @@
22

33
import com.earth2me.essentials.signs.EssentialsSign;
44
import net.ess3.api.IUser;
5+
import org.bukkit.event.HandlerList;
56

67
/**
78
* Fired when an Essentials sign is broken.
89
*
910
* This is primarily intended for use with EssentialsX's sign abstraction - external plugins should not listen on this event.
1011
*/
1112
public class SignBreakEvent extends SignEvent {
13+
private static final HandlerList handlers = new HandlerList();
14+
1215
public SignBreakEvent(final EssentialsSign.ISign sign, final EssentialsSign essSign, final IUser user) {
1316
super(sign, essSign, user);
1417
}
18+
19+
@Override
20+
public HandlerList getHandlers() {
21+
return handlers;
22+
}
23+
24+
public static HandlerList getHandlerList() {
25+
return handlers;
26+
}
1527
}

Essentials/src/main/java/net/ess3/api/events/SignCreateEvent.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,26 @@
22

33
import com.earth2me.essentials.signs.EssentialsSign;
44
import net.ess3.api.IUser;
5+
import org.bukkit.event.HandlerList;
56

67
/**
78
* Fired when an Essentials sign is created.
89
*
910
* This is primarily intended for use with EssentialsX's sign abstraction - external plugins should not listen on this event.
1011
*/
1112
public class SignCreateEvent extends SignEvent {
13+
private static final HandlerList handlers = new HandlerList();
14+
1215
public SignCreateEvent(final EssentialsSign.ISign sign, final EssentialsSign essSign, final IUser user) {
1316
super(sign, essSign, user);
1417
}
18+
19+
@Override
20+
public HandlerList getHandlers() {
21+
return handlers;
22+
}
23+
24+
public static HandlerList getHandlerList() {
25+
return handlers;
26+
}
1527
}

Essentials/src/main/java/net/ess3/api/events/SignEvent.java

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,11 @@
66
import org.bukkit.Bukkit;
77
import org.bukkit.event.Cancellable;
88
import org.bukkit.event.Event;
9-
import org.bukkit.event.HandlerList;
109

1110
/**
1211
* This handles common boilerplate for other SignEvent
1312
*/
14-
public class SignEvent extends Event implements Cancellable {
15-
private static final HandlerList handlers = new HandlerList();
13+
public abstract class SignEvent extends Event implements Cancellable {
1614
final ISign sign;
1715
final EssentialsSign essSign;
1816
final IUser user;
@@ -25,10 +23,6 @@ public SignEvent(final ISign sign, final EssentialsSign essSign, final IUser use
2523
this.user = user;
2624
}
2725

28-
public static HandlerList getHandlerList() {
29-
return handlers;
30-
}
31-
3226
public ISign getSign() {
3327
return sign;
3428
}
@@ -41,11 +35,6 @@ public IUser getUser() {
4135
return user;
4236
}
4337

44-
@Override
45-
public HandlerList getHandlers() {
46-
return handlers;
47-
}
48-
4938
@Override
5039
public boolean isCancelled() {
5140
return cancelled;

0 commit comments

Comments
 (0)