[TinyProtocol] Format TinyProtocol

Examples/TinyProtocol/src/main/java/com/comphenix/tinyprotocol/ExamplePlugin.java

@@ -12,10 +12,12 @@ import org.bukkit.plugin.java.JavaPlugin;
 import com.comphenix.tinyprotocol.Reflection.ConstructorInvoker;
 import com.comphenix.tinyprotocol.Reflection.FieldAccessor;
 
+/**
+ * Represents an example plugin utilizing TinyProtocol
+ */
 public class ExamplePlugin extends JavaPlugin {
 	// Chat packets
-	private FieldAccessor<String> CHAT_MESSAGE = Reflection.getField(
+	private FieldAccessor<String> CHAT_MESSAGE = Reflection.getField("{nms}.PacketPlayInChat", String.class, 0);
-			"{nms}.PacketPlayInChat", String.class, 0);
 
 	// Explosion packet
 	private Class<?> particleClass = Reflection.getClass("{nms}.PacketPlayOutWorldParticles");
@@ -38,6 +40,7 @@ public class ExamplePlugin extends JavaPlugin {
 	@Override
 	public void onEnable() {
 		protocol = new TinyProtocol(this) {
+
 			@Override
 			public Object onPacketInAsync(Player sender, Channel channel, Object packet) {
 				// Cancel chat packets
@@ -47,9 +50,11 @@ public class ExamplePlugin extends JavaPlugin {
 						return null;
 					}
 				}
+
 				if (particleName.hasField(packet)) {
 					System.out.println("Sending particle field:" + packet);
 				}
+
 				return super.onPacketInAsync(sender, channel, packet);
 			}
 
@@ -60,11 +65,13 @@ public class ExamplePlugin extends JavaPlugin {
 					playerSample.set(ping, playerSampleInvoker.invoke(1000, 0));
 
 					// Which is equivalent to:
-					//serverPing.get(packet).setPlayerSample(new ServerPingPlayerSample(1000, 0));
+					// serverPing.get(packet).setPlayerSample(new ServerPingPlayerSample(1000, 0));
 					return packet;
 				}
+
 				return super.onPacketOutAsync(reciever, channel, packet);
 			}
+
 		};
 	}
 
@@ -81,10 +88,12 @@ public class ExamplePlugin extends JavaPlugin {
 				protocol.injectPlayer(player);
 				sender.sendMessage(ChatColor.DARK_GREEN + "Player " + player + " has been injected.");
 			}
+
 			return true;
 		} else {
 			sender.sendMessage(ChatColor.RED + "Can only be invoked by a player.");
 		}
+
 		return false;
 	}
 
@@ -101,7 +110,6 @@ public class ExamplePlugin extends JavaPlugin {
 
 			// Send the packet to the player
 			protocol.sendPacket(player, explosionPacket);
-			
 		} catch (Exception e) {
 			throw new RuntimeException("Cannot send packet.", e);
 		}

Examples/TinyProtocol/src/main/java/com/comphenix/tinyprotocol/Reflection.java

@@ -11,6 +11,7 @@ import org.bukkit.Bukkit;
 
 /**
  * An utility class that simplifies reflection in Bukkit plugins.
+ * 
  * @author Kristian
  */
 public final class Reflection {
@@ -20,6 +21,7 @@ public final class Reflection {
 	public interface ConstructorInvoker {
 		/**
 		 * Invoke a constructor for a specific class.
+		 * 
 		 * @param arguments - the arguments to pass to the constructor.
 		 * @return The constructed object.
 		 */
@@ -32,6 +34,7 @@ public final class Reflection {
 	public interface MethodInvoker {
 		/**
 		 * Invoke a method on a specific target object.
+		 * 
 		 * @param target - the target object, or NULL for a static method.
 		 * @param arguments - the arguments to pass to the method.
 		 * @return The return value, or NULL if is void.
@@ -41,11 +44,13 @@ public final class Reflection {
 
 	/**
 	 * An interface for retrieving the field content.
+	 * 
 	 * @param <T> - field type.
 	 */
 	public interface FieldAccessor<T> {
 		/**
 		 * Retrieve the content of a field.
+		 * 
 		 * @param target - the target object, or NULL for a static field.
 		 * @return The value of the field.
 		 */
@@ -53,6 +58,7 @@ public final class Reflection {
 
 		/**
 		 * Set the content of a field.
+		 * 
 		 * @param target - the target object, or NULL for a static field.
 		 * @param value - the new value of the field.
 		 */
@@ -60,6 +66,7 @@ public final class Reflection {
 
 		/**
 		 * Determine if the given object has this field.
+		 * 
 		 * @param target - the object to test.
 		 * @return TRUE if it does, FALSE otherwise.
 		 */
@@ -80,6 +87,7 @@ public final class Reflection {
 
 	/**
 	 * Retrieve a field accessor for a specific field type and name.
+	 * 
 	 * @param target - the target type.
 	 * @param name - the name of the field, or NULL to ignore.
 	 * @param fieldType - a compatible field type.
@@ -91,6 +99,7 @@ public final class Reflection {
 
 	/**
 	 * Retrieve a field accessor for a specific field type and name.
+	 * 
 	 * @param className - lookup name of the class, see {@link #getClass(String)}.
 	 * @param name - the name of the field, or NULL to ignore.
 	 * @param fieldType - a compatible field type.
@@ -102,6 +111,7 @@ public final class Reflection {
 
 	/**
 	 * Retrieve a field accessor for a specific field type and name.
+	 * 
 	 * @param target - the target type.
 	 * @param fieldType - a compatible field type.
 	 * @param index - the number of compatible fields to skip.
@@ -113,6 +123,7 @@ public final class Reflection {
 
 	/**
 	 * Retrieve a field accessor for a specific field type and name.
+	 * 
 	 * @param className - lookup name of the class, see {@link #getClass(String)}.
 	 * @param fieldType - a compatible field type.
 	 * @param index - the number of compatible fields to skip.
@@ -125,14 +136,14 @@ public final class Reflection {
 	// Common method
 	private static <T> FieldAccessor<T> getField(Class<?> target, String name, Class<T> fieldType, int index) {
 		for (final Field field : target.getDeclaredFields()) {
-			if ((name == null || field.getName().equals(name)) && 
+			if ((name == null || field.getName().equals(name)) && fieldType.isAssignableFrom(field.getType()) && index-- <= 0) {
-					fieldType.isAssignableFrom(field.getType()) && index-- <= 0) {
 				field.setAccessible(true);
 
 				// A function for retrieving a specific field value
 				return new FieldAccessor<T>() {
-					@SuppressWarnings("unchecked")
+
 					@Override
+					@SuppressWarnings("unchecked")
 					public T get(Object target) {
 						try {
 							return (T) field.get(target);
@@ -162,11 +173,13 @@ public final class Reflection {
 		// Search in parent classes
 		if (target.getSuperclass() != null)
 			return getField(target.getSuperclass(), name, fieldType, index);
+
 		throw new IllegalArgumentException("Cannot find field with type " + fieldType);
 	}
 
 	/**
 	 * Search for the first publically and privately defined method of the given name and parameter count.
+	 * 
 	 * @param className - lookup name of the class, see {@link #getClass(String)}.
 	 * @param methodName - the method name, or NULL to skip.
 	 * @param params - the expected parameters.
@@ -179,6 +192,7 @@ public final class Reflection {
 
 	/**
 	 * Search for the first publically and privately defined method of the given name and parameter count.
+	 * 
 	 * @param clazz - a class to start with.
 	 * @param methodName - the method name, or NULL to skip.
 	 * @param params - the expected parameters.
@@ -191,6 +205,7 @@ public final class Reflection {
 
 	/**
 	 * Search for the first publically and privately defined method of the given name and parameter count.
+	 * 
 	 * @param clazz - a class to start with.
 	 * @param methodName - the method name, or NULL to skip.
 	 * @param returnType - the expected return type, or NULL to ignore.
@@ -200,12 +215,11 @@ public final class Reflection {
 	 */
 	public static MethodInvoker getTypedMethod(Class<?> clazz, String methodName, Class<?> returnType, Class<?>... params) {
 		for (final Method method : clazz.getDeclaredMethods()) {
-            if ((methodName == null || method.getName().equals(methodName)) &&
+			if ((methodName == null || method.getName().equals(methodName)) && (returnType == null) || method.getReturnType().equals(returnType) && Arrays.equals(method.getParameterTypes(), params)) {
-            	(returnType == null) || method.getReturnType().equals(returnType) &&
-                 Arrays.equals(method.getParameterTypes(), params)) {
-
 				method.setAccessible(true);
+
 				return new MethodInvoker() {
+
 					@Override
 					public Object invoke(Object target, Object... arguments) {
 						try {
@@ -214,18 +228,21 @@ public final class Reflection {
 							throw new RuntimeException("Cannot invoke method " + method, e);
 						}
 					}
+
 				};
 			}
 		}
+
 		// Search in every superclass
 		if (clazz.getSuperclass() != null)
 			return getMethod(clazz.getSuperclass(), methodName, params);
-        throw new IllegalStateException(String.format(
+
-            "Unable to find method %s (%s).", methodName, Arrays.asList(params)));
+		throw new IllegalStateException(String.format("Unable to find method %s (%s).", methodName, Arrays.asList(params)));
 	}
 
 	/**
 	 * Search for the first publically and privately defined constructor of the given name and parameter count.
+	 * 
 	 * @param className - lookup name of the class, see {@link #getClass(String)}.
 	 * @param params - the expected parameters.
 	 * @return An object that invokes this constructor.
@@ -237,6 +254,7 @@ public final class Reflection {
 
 	/**
 	 * Search for the first publically and privately defined constructor of the given name and parameter count.
+	 * 
 	 * @param clazz - a class to start with.
 	 * @param params - the expected parameters.
 	 * @return An object that invokes this constructor.
@@ -245,9 +263,10 @@ public final class Reflection {
 	public static ConstructorInvoker getConstructor(Class<?> clazz, Class<?>... params) {
 		for (final Constructor<?> constructor : clazz.getDeclaredConstructors()) {
 			if (Arrays.equals(constructor.getParameterTypes(), params)) {
-
 				constructor.setAccessible(true);
+
 				return new ConstructorInvoker() {
+
 					@Override
 					public Object invoke(Object... arguments) {
 						try {
@@ -256,11 +275,12 @@ public final class Reflection {
 							throw new RuntimeException("Cannot invoke constructor " + constructor, e);
 						}
 					}
+
 				};
 			}
 		}
-        throw new IllegalStateException(String.format(
+
-            "Unable to find constructor for %s (%s).", clazz, Arrays.asList(params)));
+		throw new IllegalStateException(String.format("Unable to find constructor for %s (%s).", clazz, Arrays.asList(params)));
 	}
 
 	/**
@@ -268,21 +288,21 @@ public final class Reflection {
 	 * <p>
 	 * This is useful when looking up fields by a NMS or OBC type.
 	 * <p>
+	 * 
 	 * @see {@link #getClass()} for more information.
 	 * @param lookupName - the class name with variables.
 	 * @return The class.
 	 */
 	public static Class<Object> getUntypedClass(String lookupName) {
-    	@SuppressWarnings({"rawtypes", "unchecked"})
+		@SuppressWarnings({ "rawtypes", "unchecked" })
-		Class<Object> clazz = (Class<Object>)(Class)getClass(lookupName);
+		Class<Object> clazz = (Class) getClass(lookupName);
 		return clazz;
 	}
 
 	/**
 	 * Retrieve a class from its full name.
 	 * <p>
-     * Strings enclosed with curly brackets - such as {TEXT} - will be replaced according 
+	 * Strings enclosed with curly brackets - such as {TEXT} - will be replaced according to the following table:
-     * to the following table:
 	 * <p>
 	 * <table border="1">
 	 * <tr>
@@ -302,6 +322,7 @@ public final class Reflection {
 	 * <td>The current Minecraft package VERSION, if any.</td>
 	 * </tr>
 	 * </table>
+	 * 
 	 * @param lookupName - the class name with variables.
 	 * @return The looked up class.
 	 * @throws IllegalArgumentException If a variable or class could not be found.
@@ -312,6 +333,7 @@ public final class Reflection {
 
 	/**
 	 * Retrieve a class in the net.minecraft.server.VERSION.* package.
+	 * 
 	 * @param name - the name of the class, excluding the package.
 	 * @throws IllegalArgumentException If the class doesn't exist.
 	 */
@@ -321,6 +343,7 @@ public final class Reflection {
 
 	/**
 	 * Retrieve a class in the org.bukkit.craftbukkit.VERSION.* package.
+	 * 
 	 * @param name - the name of the class, excluding the package.
 	 * @throws IllegalArgumentException If the class doesn't exist.
 	 */
@@ -330,6 +353,7 @@ public final class Reflection {
 
 	/**
 	 * Retrieve a class by its canonical name.
+	 * 
 	 * @param canonicalName - the canonical name.
 	 * @return The class.
 	 */
@@ -343,6 +367,7 @@ public final class Reflection {
 
 	/**
 	 * Expand variables such as "{nms}" and "{obc}" to their corresponding packages.
+	 * 
 	 * @param name - the full name of the class.
 	 * @return The expanded string.
 	 */
@@ -369,6 +394,7 @@ public final class Reflection {
 				replacement += ".";
 			matcher.appendReplacement(output, Matcher.quoteReplacement(replacement));
 		}
+
 		matcher.appendTail(output);
 		return output.toString();
 	}

Examples/TinyProtocol/src/main/java/com/comphenix/tinyprotocol/TinyProtocol.java

@@ -34,9 +34,10 @@ import com.google.common.collect.MapMaker;
 import com.mojang.authlib.GameProfile;
 
 /**
- * Represents a very tiny alternative to ProtocolLib in 1.7.2.
+ * Represents a very tiny alternative to ProtocolLib.
  * <p>
  * It now supports intercepting packets during login and status ping (such as OUT_SERVER_PING)!
+ * 
  * @author Kristian
  */
 public abstract class TinyProtocol {
@@ -85,6 +86,7 @@ public abstract class TinyProtocol {
 	 * Construct a new instance of TinyProtocol, and start intercepting packets for all connected clients and future clients.
 	 * <p>
 	 * You can construct multiple instances per plugin.
+	 * 
 	 * @param plugin - the plugin.
 	 */
 	public TinyProtocol(Plugin plugin) {
@@ -102,31 +104,36 @@ public abstract class TinyProtocol {
 	private void createServerChannelHandler() {
 		// Handle connected channels
 		endInitProtocol = new ChannelInitializer<Channel>() {
+
 			@Override
 			protected void initChannel(Channel channel) throws Exception {
 				try {
 					// This can take a while, so we need to stop the main thread from interfering
 					synchronized (networkManagers) {
 						// Stop injecting channels
-                    	if (closed)
+						if (!closed) {
-                    		return;
 							injectChannelInternal(channel);
 						}
+					}
 				} catch (Exception e) {
 					plugin.getLogger().log(Level.SEVERE, "Cannot inject incomming channel " + channel, e);
 				}
 			}
+
 		};
 
 		// This is executed before Minecraft's channel handler
 		beginInitProtocol = new ChannelInitializer<Channel>() {
+
 			@Override
 			protected void initChannel(Channel channel) throws Exception {
 				channel.pipeline().addLast(endInitProtocol);
 			}
+
 		};
 
 		serverChannelHandler = new ChannelInboundHandlerAdapter() {
+	
 			@Override
 			public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
 				Channel channel = (Channel) msg;
@@ -135,6 +142,7 @@ public abstract class TinyProtocol {
 				channel.pipeline().addFirst(beginInitProtocol);
 				ctx.fireChannelRead(msg);
 			}
+
 		};
 	}
 
@@ -143,10 +151,12 @@ public abstract class TinyProtocol {
 	 */
 	private void registerBukkitEvents() {
 		listener = new Listener() {
+
 			@EventHandler(priority = EventPriority.LOWEST)
 			public final void onPlayerLogin(PlayerLoginEvent e) {
 				if (closed)
 					return;
+
 				Channel channel = getChannel(e.getPlayer());
 
 				// Don't inject players that have been explicitly uninjected
@@ -161,9 +171,10 @@ public abstract class TinyProtocol {
 					close();
 				}
 			}
+
 		};
 
-		this.plugin.getServer().getPluginManager().registerEvents(listener, plugin);
+		plugin.getServer().getPluginManager().registerEvents(listener, plugin);
 	}
 
 	@SuppressWarnings("unchecked")
@@ -185,7 +196,7 @@ public abstract class TinyProtocol {
 					break;
 
 				// Channel future that contains the server connection
-				Channel serverChannel = ((ChannelFuture)item).channel();
+				Channel serverChannel = ((ChannelFuture) item).channel();
 
 				serverChannels.add(serverChannel);
 				serverChannel.pipeline().addFirst(serverChannelHandler);
@@ -203,6 +214,7 @@ public abstract class TinyProtocol {
 
 			// Remove channel handler
 			serverChannel.eventLoop().execute(new Runnable() {
+
 				@Override
 				public void run() {
 					try {
@@ -211,6 +223,7 @@ public abstract class TinyProtocol {
 						// That's fine
 					}
 				}
+
 			});
 		}
 	}
@@ -225,6 +238,7 @@ public abstract class TinyProtocol {
 	 * Invoked when the server is starting to send a packet to a player.
 	 * <p>
 	 * Note that this is not executed on the main thread.
+	 * 
 	 * @param reciever - the receiving player, NULL for early login/status packets.
 	 * @param remoteAddress - remote address of the sending client. Never NULL.
 	 * @param packet - the packet being sent.
@@ -238,6 +252,7 @@ public abstract class TinyProtocol {
 	 * Invoked when the server has received a packet from a given player.
 	 * <p>
 	 * Use {@link Channel#remoteAddress()} to get the remote address of the client.
+	 * 
 	 * @param sender - the player that sent the packet, NULL for early login/status packets.
 	 * @param channel - channel that received the packet. Never NULL.
 	 * @param packet - the packet being received.
@@ -251,6 +266,7 @@ public abstract class TinyProtocol {
 	 * Send a packet to a particular player.
 	 * <p>
 	 * Note that {@link #onPacketOutAsync(Player, Object)} will be invoked with this packet.
+	 * 
 	 * @param player - the destination player.
 	 * @param packet - the packet to send.
 	 */
@@ -262,6 +278,7 @@ public abstract class TinyProtocol {
 	 * Send a packet to a particular client.
 	 * <p>
 	 * Note that {@link #onPacketOutAsync(Player, Object)} will be invoked with this packet.
+	 * 
 	 * @param channel - client identified by a channel.
 	 * @param packet - the packet to send.
 	 */
@@ -273,6 +290,7 @@ public abstract class TinyProtocol {
 	 * Pretend that a given packet has been received from a player.
 	 * <p>
 	 * Note that {@link #onPacketInAsync(Player, Object)} will be invoked with this packet.
+	 * 
 	 * @param player - the player that sent the packet.
 	 * @param packet - the packet that will be received by the server.
 	 */
@@ -284,6 +302,7 @@ public abstract class TinyProtocol {
 	 * Pretend that a given packet has been received from a given client.
 	 * <p>
 	 * Note that {@link #onPacketInAsync(Player, Object)} will be invoked with this packet.
+	 * 
 	 * @param channel - client identified by a channel.
 	 * @param packet - the packet that will be received by the server.
 	 */
@@ -295,6 +314,7 @@ public abstract class TinyProtocol {
 	 * Retrieve the name of the channel injector, default implementation is "tiny-" + plugin name + "-" + a unique ID.
 	 * <p>
 	 * Note that this method will only be invoked once. It is no longer necessary to override this to support multiple instances.
+	 * 
 	 * @return A unique channel handler name.
 	 */
 	protected String getHandlerName() {
@@ -302,10 +322,10 @@ public abstract class TinyProtocol {
 	}
 
 	/**
-	 * Add a custom channel handler to the given player's channel pipeline,
+	 * Add a custom channel handler to the given player's channel pipeline, allowing us to intercept sent and received packets.
-	 * allowing us to intercept sent and received packets.
 	 * <p>
 	 * This will automatically be called when a player has logged in.
+	 * 
 	 * @param player - the player to inject.
 	 */
 	public void injectPlayer(Player player) {
@@ -314,6 +334,7 @@ public abstract class TinyProtocol {
 
 	/**
 	 * Add a custom channel handler to the given channel.
+	 * 
 	 * @param player - the channel to inject.
 	 * @return The intercepted channel, or NULL if it has already been injected.
 	 */
@@ -323,6 +344,7 @@ public abstract class TinyProtocol {
 
 	/**
 	 * Add a custom channel handler to the given channel.
+	 * 
 	 * @param player - the channel to inject.
 	 * @return The packet interceptor.
 	 */
@@ -336,6 +358,7 @@ public abstract class TinyProtocol {
 				channel.pipeline().addBefore("packet_handler", handlerName, interceptor);
 				uninjectedChannels.remove(channel);
 			}
+
 			return interceptor;
 		} catch (IllegalArgumentException e) {
 			// Try again
@@ -345,6 +368,7 @@ public abstract class TinyProtocol {
 
 	/**
 	 * Retrieve the Netty channel associated with a player. This is cached.
+	 * 
 	 * @param player - the player.
 	 * @return The Netty channel.
 	 */
@@ -358,11 +382,13 @@ public abstract class TinyProtocol {
 
 			channelLookup.put(player.getName(), channel = getChannel.get(manager));
 		}
+
 		return channel;
 	}
 
 	/**
 	 * Uninject a specific player.
+	 * 
 	 * @param player - the injected player.
 	 */
 	public void uninjectPlayer(Player player) {
@@ -373,6 +399,7 @@ public abstract class TinyProtocol {
 	 * Uninject a specific channel.
 	 * <p>
 	 * This will also disable the automatic channel injection that occurs when a player has properly logged in.
+	 * 
 	 * @param channel - the injected channel.
 	 */
 	public void uninjectChannel(final Channel channel) {
@@ -383,15 +410,18 @@ public abstract class TinyProtocol {
 
 		// See ChannelInjector in ProtocolLib, line 590
 		channel.eventLoop().execute(new Runnable() {
+
 			@Override
 			public void run() {
 				channel.pipeline().remove(handlerName);
 			}
+
 		});
 	}
 
 	/**
 	 * Determine if the given player has been injected by TinyProtocol.
+	 * 
 	 * @param player - the player.
 	 * @return TRUE if it is, FALSE otherwise.
 	 */
@@ -401,6 +431,7 @@ public abstract class TinyProtocol {
 
 	/**
 	 * Determine if the given channel has been injected by TinyProtocol.
+	 * 
 	 * @param channel - the channel.
 	 * @return TRUE if it is, FALSE otherwise.
 	 */
@@ -419,6 +450,7 @@ public abstract class TinyProtocol {
 			for (Player player : plugin.getServer().getOnlinePlayers()) {
 				uninjectPlayer(player);
 			}
+
 			// Clean up Bukkit
 			HandlerList.unregisterAll(listener);
 			unregisterChannelHandler();
@@ -427,6 +459,7 @@ public abstract class TinyProtocol {
 
 	/**
 	 * Channel handler that is inserted into the player's channel pipeline, allowing us to intercept sent and received packets.
+	 * 
 	 * @author Kristian
 	 */
 	private final class PacketInterceptor extends ChannelDuplexHandler {
@@ -449,6 +482,7 @@ public abstract class TinyProtocol {
 				super.channelRead(ctx, msg);
 			}
 		}
+
 		@Override
 		public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
 			try {