SteamWar/ProtocolLib
Archiviert
13
0
Fork 0
Code Issues Pull-Requests Releases Wiki Aktivität

Renamed AdapterParmeteters to AdapterParameters

Quellcode durchsuchen 
Added a new .param(Plugin, PacketType...) method to replace deprecated
Minor Javadoc edits
Dieser Commit ist enthalten in:
Devil Boy 2013-12-05 11:55:00 -08:00
Ursprung 79c1e81c02
Commit a9dbca0bfb
1 geänderte Dateien mit 35 neuen und 23 gelöschten Zeilen
Statistiken anzeigen Patch-Datei herunterladen Vergleichs-Datei herunterladen Alle Dateien ausklappen Alle Dateien einklappen

58
ProtocolLib/src/main/java/com/comphenix/protocol/events/PacketAdapter.java
Datei anzeigen

@ -48,7 +48,7 @@ public abstract class PacketAdapter implements PacketListener {
* Initialize a packet adapter using a collection of parameters. Use {@link #params()} to get an instance to this builder. * Initialize a packet adapter using a collection of parameters. Use {@link #params()} to get an instance to this builder.
* @param params - the parameters. * @param params - the parameters.
*/ */
public PacketAdapter(@Nonnull AdapterParameteters params) { public PacketAdapter(@Nonnull AdapterParameters params) {
this( this(
checkValidity(params).plugin, params.connectionSide, params.listenerPriority, checkValidity(params).plugin, params.connectionSide, params.listenerPriority,
params.gamePhase, params.options, params.packets params.gamePhase, params.options, params.packets
@ -324,29 +324,41 @@ public abstract class PacketAdapter implements PacketListener {
* This is often simpler and better than passing them directly to each constructor. * This is often simpler and better than passing them directly to each constructor.
* @return Helper object. * @return Helper object.
*/ */
public static AdapterParameteters params() { public static AdapterParameters params() {
return new AdapterParameteters(); return new AdapterParameters();
} }
/** /**
* Construct a helper object for passing parameters to the packet adapter. * Construct a helper object for passing parameters to the packet adapter.
* <p> * <p>
* This is often simpler and better than passing them directly to each constructor. * This is often simpler and better than passing them directly to each constructor.
* Deprecated: Use {@link #types(PacketType...)} instead. * Deprecated: Use {@link #params(Plugin, PacketType...)} instead.
* @param plugin - the plugin that spawned this listener. * @param plugin - the plugin that spawned this listener.
* @param packets - the packet IDs the listener is looking for. * @param packets - the packet IDs the listener is looking for.
* @return Helper object. * @return Helper object.
*/ */
@Deprecated @Deprecated
public static AdapterParameteters params(Plugin plugin, Integer... packets) { public static AdapterParameters params(Plugin plugin, Integer... packets) {
return new AdapterParameteters().plugin(plugin).packets(packets); return new AdapterParameters().plugin(plugin).packets(packets);
}
/**
* Construct a helper object for passing parameters to the packet adapter.
* <p>
* This is often simpler and better than passing them directly to each constructor.
* @param plugin - the plugin that spawned this listener.
* @param packets - the packet types the listener is looking for.
* @return Helper object.
*/
public static AdapterParameters params(Plugin plugin, PacketType... packets) {
return new AdapterParameters().plugin(plugin).types(packets);
} }
/** /**
* Represents a builder for passing parameters to the packet adapter constructor. * Represents a builder for passing parameters to the packet adapter constructor.
* @author Kristian * @author Kristian
*/ */
public static class AdapterParameteters { public static class AdapterParameters {
private Plugin plugin; private Plugin plugin;
private ConnectionSide connectionSide; private ConnectionSide connectionSide;
private PacketType[] packets; private PacketType[] packets;
@ -361,7 +373,7 @@ public abstract class PacketAdapter implements PacketListener {
* @param plugin - the plugin. * @param plugin - the plugin.
* @return This builder, for chaining. * @return This builder, for chaining.
*/ */
public AdapterParameteters plugin(@Nonnull Plugin plugin) { public AdapterParameters plugin(@Nonnull Plugin plugin) {
this.plugin = Preconditions.checkNotNull(plugin, "plugin cannot be NULL."); this.plugin = Preconditions.checkNotNull(plugin, "plugin cannot be NULL.");
return this; return this;
} }
@ -371,7 +383,7 @@ public abstract class PacketAdapter implements PacketListener {
* @param connectionSide - the new packet type. * @param connectionSide - the new packet type.
* @return This builder, for chaining. * @return This builder, for chaining.
*/ */
public AdapterParameteters connectionSide(@Nonnull ConnectionSide connectionSide) { public AdapterParameters connectionSide(@Nonnull ConnectionSide connectionSide) {
this.connectionSide = Preconditions.checkNotNull(connectionSide, "connectionside cannot be NULL."); this.connectionSide = Preconditions.checkNotNull(connectionSide, "connectionside cannot be NULL.");
return this; return this;
} }
@ -380,7 +392,7 @@ public abstract class PacketAdapter implements PacketListener {
* Set this adapter to also look for client-side packets. * Set this adapter to also look for client-side packets.
* @return This builder, for chaining. * @return This builder, for chaining.
*/ */
public AdapterParameteters clientSide() { public AdapterParameters clientSide() {
return connectionSide(ConnectionSide.add(connectionSide, ConnectionSide.CLIENT_SIDE)); return connectionSide(ConnectionSide.add(connectionSide, ConnectionSide.CLIENT_SIDE));
} }
@ -388,7 +400,7 @@ public abstract class PacketAdapter implements PacketListener {
* Set this adapter to also look for server-side packets. * Set this adapter to also look for server-side packets.
* @return This builder, for chaining. * @return This builder, for chaining.
*/ */
public AdapterParameteters serverSide() { public AdapterParameters serverSide() {
return connectionSide(ConnectionSide.add(connectionSide, ConnectionSide.SERVER_SIDE)); return connectionSide(ConnectionSide.add(connectionSide, ConnectionSide.SERVER_SIDE));
} }
@ -399,7 +411,7 @@ public abstract class PacketAdapter implements PacketListener {
* @param listenerPriority - the new event priority. * @param listenerPriority - the new event priority.
* @return This builder, for chaining. * @return This builder, for chaining.
*/ */
public AdapterParameteters listenerPriority(@Nonnull ListenerPriority listenerPriority) { public AdapterParameters listenerPriority(@Nonnull ListenerPriority listenerPriority) {
this.listenerPriority = Preconditions.checkNotNull(listenerPriority, "listener priority cannot be NULL."); this.listenerPriority = Preconditions.checkNotNull(listenerPriority, "listener priority cannot be NULL.");
return this; return this;
} }
@ -411,7 +423,7 @@ public abstract class PacketAdapter implements PacketListener {
* @param gamePhase - the new game phase. * @param gamePhase - the new game phase.
* @return This builder, for chaining. * @return This builder, for chaining.
*/ */
public AdapterParameteters gamePhase(@Nonnull GamePhase gamePhase) { public AdapterParameters gamePhase(@Nonnull GamePhase gamePhase) {
this.gamePhase = Preconditions.checkNotNull(gamePhase, "gamePhase cannot be NULL."); this.gamePhase = Preconditions.checkNotNull(gamePhase, "gamePhase cannot be NULL.");
return this; return this;
} }
@ -420,7 +432,7 @@ public abstract class PacketAdapter implements PacketListener {
* Set the game phase to {@link GamePhase#LOGIN}, allowing ProtocolLib to intercept login packets. * Set the game phase to {@link GamePhase#LOGIN}, allowing ProtocolLib to intercept login packets.
* @return This builder, for chaining. * @return This builder, for chaining.
*/ */
public AdapterParameteters loginPhase() { public AdapterParameters loginPhase() {
return gamePhase(GamePhase.LOGIN); return gamePhase(GamePhase.LOGIN);
} }
@ -431,7 +443,7 @@ public abstract class PacketAdapter implements PacketListener {
* @param options - every option to use. * @param options - every option to use.
* @return This builder, for chaining. * @return This builder, for chaining.
*/ */
public AdapterParameteters options(@Nonnull ListenerOptions... options) { public AdapterParameters options(@Nonnull ListenerOptions... options) {
this.options = Preconditions.checkNotNull(options, "options cannot be NULL."); this.options = Preconditions.checkNotNull(options, "options cannot be NULL.");
return this; return this;
} }
@ -440,7 +452,7 @@ public abstract class PacketAdapter implements PacketListener {
* Set the listener option to {@link ListenerOptions#INTERCEPT_INPUT_BUFFER}, causing ProtocolLib to read the raw packet data from the network stream. * Set the listener option to {@link ListenerOptions#INTERCEPT_INPUT_BUFFER}, causing ProtocolLib to read the raw packet data from the network stream.
* @return This builder, for chaining. * @return This builder, for chaining.
*/ */
public AdapterParameteters optionIntercept() { public AdapterParameters optionIntercept() {
return options(ListenerOptions.INTERCEPT_INPUT_BUFFER); return options(ListenerOptions.INTERCEPT_INPUT_BUFFER);
} }
@ -454,7 +466,7 @@ public abstract class PacketAdapter implements PacketListener {
* @return This builder, for chaining. * @return This builder, for chaining.
*/ */
@Deprecated @Deprecated
public AdapterParameteters packets(@Nonnull Integer... packets) { public AdapterParameters packets(@Nonnull Integer... packets) {
Preconditions.checkNotNull(packets, "packets cannot be NULL"); Preconditions.checkNotNull(packets, "packets cannot be NULL");
PacketType[] types = new PacketType[packets.length]; PacketType[] types = new PacketType[packets.length];
@ -473,7 +485,7 @@ public abstract class PacketAdapter implements PacketListener {
* @return This builder, for chaining. * @return This builder, for chaining.
*/ */
@Deprecated @Deprecated
public AdapterParameteters packets(@Nonnull Set<Integer> packets) { public AdapterParameters packets(@Nonnull Set<Integer> packets) {
return packets(packets.toArray(new Integer[0])); return packets(packets.toArray(new Integer[0]));
} }
@ -481,10 +493,10 @@ public abstract class PacketAdapter implements PacketListener {
* Set the packet types the listener is looking for. * Set the packet types the listener is looking for.
* <p> * <p>
* This parameter is required. * This parameter is required.
* @param packets * @param packets - the packet types to look for.
* @return This builder, for chaining. * @return This builder, for chaining.
*/ */
public AdapterParameteters types(@Nonnull PacketType... packets) { public AdapterParameters types(@Nonnull PacketType... packets) {
this.packets = Preconditions.checkNotNull(packets, "packets cannot be NULL"); this.packets = Preconditions.checkNotNull(packets, "packets cannot be NULL");
return this; return this;
} }
@ -493,10 +505,10 @@ public abstract class PacketAdapter implements PacketListener {
* Set the packet types the listener is looking for. * Set the packet types the listener is looking for.
* <p> * <p>
* This parameter is required. * This parameter is required.
* @param packets * @param packets - a set of packet types to look for.
* @return This builder, for chaining. * @return This builder, for chaining.
*/ */
public AdapterParameteters types(@Nonnull Set<PacketType> packets) { public AdapterParameters types(@Nonnull Set<PacketType> packets) {
return types(packets.toArray(new PacketType[0])); return types(packets.toArray(new PacketType[0]));
} }
} }
@ -504,7 +516,7 @@ public abstract class PacketAdapter implements PacketListener {
/** /**
* Determine if the required parameters are set. * Determine if the required parameters are set.
*/ */
private static AdapterParameteters checkValidity(AdapterParameteters params) { private static AdapterParameters checkValidity(AdapterParameters params) {
if (params == null) if (params == null)
throw new IllegalArgumentException("params cannot be NULL."); throw new IllegalArgumentException("params cannot be NULL.");
if (params.plugin == null) if (params.plugin == null)