com.comphenix.protocol.utility

Class MinecraftReflection

java.lang.Object

com.comphenix.protocol.utility.MinecraftReflection

public class MinecraftReflection
extends java.lang.Object

Methods and constants specifically used in conjuction with reflecting Minecraft object.

Author:

Kristian

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MINECRAFT_OBJECT Regular expression that matches a Minecraft object.

Constructor Summary

Constructors

Constructor and Description
MinecraftReflection()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.Class<?>	getArrayClass(java.lang.Class<?> componentType) Retrieve the array class of a given component type.
static java.lang.Object	getBukkitEntity(java.lang.Object nmsObject) Dynamically retrieve the Bukkit entity from a given entity.
static org.bukkit.inventory.ItemStack	getBukkitItemStack(org.bukkit.inventory.ItemStack bukkitItemStack) Retrieve a CraftItemStack from a given ItemStack.
static org.bukkit.inventory.ItemStack	getBukkitItemStack(java.lang.Object minecraftItemStack) Retrieve the Bukkit ItemStack from a given net.minecraft.server ItemStack.
static java.lang.Class<?>	getChunkCoordinatesClass() Retrieve the ChunkPosition class.
static java.lang.Class<?>	getChunkPositionClass() Retrieve the ChunkPosition class.
static java.lang.Class	getCraftBukkitClass(java.lang.String className) Retrieve the class object of a specific CraftBukkit class.
static java.lang.String	getCraftBukkitPackage() Retrieve the name of the root CraftBukkit package.
static java.lang.Class<?>	getCraftItemStackClass() Retrieve the CraftItemStack class.
static java.lang.Class<?>	getDataWatcherClass() Retrieve the DataWatcher class.
static java.lang.Class<?>	getEntityClass() Retrieve the entity (NMS) class.
static java.lang.Class<?>	getEntityPlayerClass() Retrieve the EntityPlayer (NMS) class.
static java.lang.Class<?>	getItemStackArrayClass() Retrieve the ItemStack[] class.
static java.lang.Class<?>	getItemStackClass() Retrieve the NMS ItemStack class.
static java.lang.Class<?>	getMinecraftClass(java.lang.String className) Retrieve the class object of a specific Minecraft class.
static java.lang.Class<?>	getMinecraftClass(java.lang.String className, java.lang.String... aliases) Retrieve the first class that matches a specified Minecraft name.
static java.lang.Object	getMinecraftItemStack(org.bukkit.inventory.ItemStack stack) Retrieve the net.minecraft.server ItemStack from a Bukkit ItemStack.
static java.lang.String	getMinecraftPackage() Retrieve the name of the Minecraft server package.
static java.lang.Class<?>	getMinecraftServerClass() Retrieve the MinecraftServer class.
static java.lang.Class<?>	getNBTBaseClass() Retrieve the NBT base class.
static java.lang.Class<?>	getNetHandlerClass() Retrieve the NetHandler class.
static java.lang.Class<?>	getNetLoginHandlerClass() Retrieve the NetLoginHandler class.
static java.lang.String	getNetLoginHandlerName() Dynamically retrieve the name of the current NetLoginHandler.
static java.lang.Class<?>	getNetServerHandlerClass() Retrieve the NetServerHandler class.
static java.lang.Class<?>	getNetworkManagerClass() Retrieve the NetworkManager class.
static java.lang.String	getNetworkManagerName() Dynamically retrieve the NetworkManager name.
static java.lang.Class<?>	getPacketClass() Retrieve the packet class.
static java.lang.Class<?>	getWatchableObjectClass() Retrieve the WatchableObject class.
static java.lang.Class<?>	getWorldTypeClass() Retrieve the WorldType class.
static boolean	isChunkCoordinates(java.lang.Object obj) Determine if a given object is a ChunkCoordinate.
static boolean	isChunkPosition(java.lang.Object obj) Determine if a given object is a ChunkPosition.
static boolean	isCraftItemStack(java.lang.Object obj) Determine if the given object is a CraftItemStack instancey.
static boolean	isDataWatcher(java.lang.Object obj) Determine if the given object is a data watcher object.
static boolean	isItemStack(java.lang.Object value) Determine if the given object is a NMS ItemStack.
static boolean	isLoginHandler(java.lang.Object obj) Determine if the given object is a NetLoginHandler.
static boolean	isMinecraftEntity(java.lang.Object obj) Determine if the given object is actually a Minecraft packet.
static boolean	isMinecraftObject(java.lang.Object obj) Determine if a given object can be found within the package net.minecraft.server.
static boolean	isMinecraftObject(java.lang.Object obj, java.lang.String className) Determine if a given object is found in net.minecraft.server, and has the given name.
static boolean	isMinecraftPlayer(java.lang.Object obj) Determine if the given object is a Minecraft player entity.
static boolean	isPacketClass(java.lang.Object obj) Determine if the given object is actually a Minecraft packet.
static boolean	isWatchableObject(java.lang.Object obj) Determine if the given object is a watchable object.
static void	setMinecraftPackage(java.lang.String minecraftPackage, java.lang.String craftBukkitPackage) Used during debugging and testing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MINECRAFT_OBJECT

public static final java.lang.String MINECRAFT_OBJECT

Regular expression that matches a Minecraft object.

See Also:

Constant Field Values

Constructor Detail

MinecraftReflection

public MinecraftReflection()

Method Detail

getMinecraftPackage

public static java.lang.String getMinecraftPackage()

Retrieve the name of the Minecraft server package.

Returns:

Full canonical name of the Minecraft server package.

setMinecraftPackage

public static void setMinecraftPackage(java.lang.String minecraftPackage,
                       java.lang.String craftBukkitPackage)

Used during debugging and testing.

Parameters:

minecraftPackage - - the current Minecraft package.

craftBukkitPackage - - the current CraftBukkit package.

getCraftBukkitPackage

public static java.lang.String getCraftBukkitPackage()

Retrieve the name of the root CraftBukkit package.

Returns:

Full canonical name of the root CraftBukkit package.

getBukkitEntity

public static java.lang.Object getBukkitEntity(java.lang.Object nmsObject)

Dynamically retrieve the Bukkit entity from a given entity.

Parameters:

nmsObject - - the NMS entity.

Returns:

A bukkit entity.

Throws:

java.lang.RuntimeException - If we were unable to retrieve the Bukkit entity.

isMinecraftObject

public static boolean isMinecraftObject(@Nonnull
                        java.lang.Object obj)

Determine if a given object can be found within the package net.minecraft.server.

Parameters:

obj - - the object to test.

Returns:

TRUE if it can, FALSE otherwise.

isMinecraftObject

public static boolean isMinecraftObject(@Nonnull
                        java.lang.Object obj,
                        java.lang.String className)

Determine if a given object is found in net.minecraft.server, and has the given name.

Parameters:

obj - - the object to test.

className - - the class name to test.

Returns:

TRUE if it can, FALSE otherwise.

isChunkPosition

public static boolean isChunkPosition(java.lang.Object obj)

Determine if a given object is a ChunkPosition.

Parameters:

obj - - the object to test.

Returns:

TRUE if it can, FALSE otherwise.

isChunkCoordinates

public static boolean isChunkCoordinates(java.lang.Object obj)

Determine if a given object is a ChunkCoordinate.

Parameters:

obj - - the object to test.

Returns:

TRUE if it can, FALSE otherwise.

isPacketClass

public static boolean isPacketClass(java.lang.Object obj)

Determine if the given object is actually a Minecraft packet.

Parameters:

obj - - the given object.

Returns:

TRUE if it is, FALSE otherwise.

isLoginHandler

public static boolean isLoginHandler(java.lang.Object obj)

Determine if the given object is a NetLoginHandler.

Parameters:

obj - - the given object.

Returns:

TRUE if it is, FALSE otherwise.

isMinecraftEntity

public static boolean isMinecraftEntity(java.lang.Object obj)

Determine if the given object is actually a Minecraft packet.

Parameters:

obj - - the given object.

Returns:

TRUE if it is, FALSE otherwise.

isItemStack

public static boolean isItemStack(java.lang.Object value)

Determine if the given object is a NMS ItemStack.

Parameters:

obj - - the given object.

Returns:

TRUE if it is, FALSE otherwise.

isMinecraftPlayer

public static boolean isMinecraftPlayer(java.lang.Object obj)

Determine if the given object is a Minecraft player entity.

Parameters:

obj - - the given object.

Returns:

TRUE if it is, FALSE otherwise.

isWatchableObject

public static boolean isWatchableObject(java.lang.Object obj)

Determine if the given object is a watchable object.

Parameters:

obj - - the given object.

Returns:

TRUE if it is, FALSE otherwise.

isDataWatcher

public static boolean isDataWatcher(java.lang.Object obj)

Determine if the given object is a data watcher object.

Parameters:

obj - - the given object.

Returns:

TRUE if it is, FALSE otherwise.

isCraftItemStack

public static boolean isCraftItemStack(java.lang.Object obj)

Determine if the given object is a CraftItemStack instancey.

Parameters:

obj - - the given object.

Returns:

TRUE if it is, FALSE otherwise.

getEntityPlayerClass

public static java.lang.Class<?> getEntityPlayerClass()

Retrieve the EntityPlayer (NMS) class.

Returns:

The entity class.

getEntityClass

public static java.lang.Class<?> getEntityClass()

Retrieve the entity (NMS) class.

Returns:

The entity class.

getPacketClass

public static java.lang.Class<?> getPacketClass()

Retrieve the packet class.

Returns:

The packet class.

getNetLoginHandlerClass

public static java.lang.Class<?> getNetLoginHandlerClass()

Retrieve the NetLoginHandler class.

Returns:

The NetLoginHandler class.

getNetServerHandlerClass

public static java.lang.Class<?> getNetServerHandlerClass()

Retrieve the NetServerHandler class.

Returns:

The NetServerHandler class.

getNetworkManagerClass

public static java.lang.Class<?> getNetworkManagerClass()

Retrieve the NetworkManager class.

Returns:

The NetworkManager class.

getNetHandlerClass

public static java.lang.Class<?> getNetHandlerClass()

Retrieve the NetHandler class.

Returns:

The NetHandler class.

getItemStackClass

public static java.lang.Class<?> getItemStackClass()

Retrieve the NMS ItemStack class.

Returns:

The ItemStack class.

getWorldTypeClass

public static java.lang.Class<?> getWorldTypeClass()

Retrieve the WorldType class.

Returns:

The WorldType class.

getMinecraftServerClass

public static java.lang.Class<?> getMinecraftServerClass()

Retrieve the MinecraftServer class.

Returns:

MinecraftServer class.

getDataWatcherClass

public static java.lang.Class<?> getDataWatcherClass()

Retrieve the DataWatcher class.

Returns:

The DataWatcher class.

getChunkPositionClass

public static java.lang.Class<?> getChunkPositionClass()

Retrieve the ChunkPosition class.

Returns:

The ChunkPosition class.

getChunkCoordinatesClass

public static java.lang.Class<?> getChunkCoordinatesClass()

Retrieve the ChunkPosition class.

Returns:

The ChunkPosition class.

getWatchableObjectClass

public static java.lang.Class<?> getWatchableObjectClass()

Retrieve the WatchableObject class.

Returns:

The WatchableObject class.

getNBTBaseClass

public static java.lang.Class<?> getNBTBaseClass()

Retrieve the NBT base class.

Returns:

The NBT base class.

getItemStackArrayClass

public static java.lang.Class<?> getItemStackArrayClass()

Retrieve the ItemStack[] class.

Returns:

The ItemStack[] class.

getArrayClass

public static java.lang.Class<?> getArrayClass(java.lang.Class<?> componentType)

Retrieve the array class of a given component type.

Parameters:

componentType - - type of each element in the array.

Returns:

The class of the array.

getCraftItemStackClass

public static java.lang.Class<?> getCraftItemStackClass()

Retrieve the CraftItemStack class.

Returns:

The CraftItemStack class.

getBukkitItemStack

public static org.bukkit.inventory.ItemStack getBukkitItemStack(org.bukkit.inventory.ItemStack bukkitItemStack)

Retrieve a CraftItemStack from a given ItemStack.

Parameters:

bukkitItemStack - - the Bukkit ItemStack to convert.

Returns:

A CraftItemStack as an ItemStack.

getBukkitItemStack

public static org.bukkit.inventory.ItemStack getBukkitItemStack(java.lang.Object minecraftItemStack)

Retrieve the Bukkit ItemStack from a given net.minecraft.server ItemStack.

Parameters:

minecraftItemStack - - the NMS ItemStack to wrap.

Returns:

The wrapped ItemStack.

getMinecraftItemStack

public static java.lang.Object getMinecraftItemStack(org.bukkit.inventory.ItemStack stack)

Retrieve the net.minecraft.server ItemStack from a Bukkit ItemStack.

Parameters:

stack - - the Bukkit ItemStack to convert.

Returns:

The NMS ItemStack.

getCraftBukkitClass

public static java.lang.Class getCraftBukkitClass(java.lang.String className)

Retrieve the class object of a specific CraftBukkit class.

Parameters:

className - - the specific CraftBukkit class.

Returns:

Class object.

Throws:

java.lang.RuntimeException - If we are unable to find the given class.

getMinecraftClass

public static java.lang.Class<?> getMinecraftClass(java.lang.String className)

Retrieve the class object of a specific Minecraft class.

Parameters:

className - - the specific Minecraft class.

Returns:

Class object.

Throws:

java.lang.RuntimeException - If we are unable to find the given class.

getMinecraftClass

public static java.lang.Class<?> getMinecraftClass(java.lang.String className,
                                   java.lang.String... aliases)

Retrieve the first class that matches a specified Minecraft name.

Parameters:

classes - - the specific Minecraft class.

Returns:

Class object.

Throws:

java.lang.RuntimeException - If we are unable to find any of the given classes.

getNetworkManagerName

public static java.lang.String getNetworkManagerName()

Dynamically retrieve the NetworkManager name.

Returns:

Name of the NetworkManager class.

getNetLoginHandlerName

public static java.lang.String getNetLoginHandlerName()

Dynamically retrieve the name of the current NetLoginHandler.

Returns:

Name of the NetLoginHandler class.