com.comphenix.protocol.events

Class PacketContainer

java.lang.Object

com.comphenix.protocol.events.PacketContainer

All Implemented Interfaces:

java.io.Serializable

public class PacketContainer
extends java.lang.Object
implements java.io.Serializable

Represents a Minecraft packet indirectly.

Author:

Kristian

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object	handle
protected int	id
protected StructureModifier<java.lang.Object>	structureModifier

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PacketContainer() For serialization.
	PacketContainer(int id) Creates a packet container for a new packet.
	PacketContainer(int id, java.lang.Object handle) Creates a packet container for an existing packet.
	PacketContainer(int id, java.lang.Object handle, StructureModifier<java.lang.Object> structure) Creates a packet container for an existing packet.

Method Summary

Methods

Modifier and Type	Method and Description
PacketContainer	deepClone() Create a deep copy of the current packet.
StructureModifier<byte[]>	getByteArrays() Retrieves a read/write structure for every byte array field.
StreamSerializer	getByteArraySerializer() Retrieve a serializer for reading and writing ItemStacks stored in a byte array.
StructureModifier<java.lang.Byte>	getBytes() Retrieves a read/write structure for every byte field.
StructureModifier<WrappedDataWatcher>	getDataWatcherModifier() Retrieves a read/write structure for data watchers.
StructureModifier<java.lang.Double>	getDoubles() Retrieves a read/write structure for every double field.
StructureModifier<org.bukkit.entity.Entity>	getEntityModifier(org.bukkit.World world) Retrieves a read/write structure for entity objects.
StructureModifier<java.lang.Float>	getFloat() Retrieves a read/write structure for every float field.
java.lang.Object	getHandle() Retrieves the underlying Minecraft packet.
int	getID() Retrieves the ID of this packet.
StructureModifier<int[]>	getIntegerArrays() Retrieves a read/write structure for every int array field.
StructureModifier<java.lang.Integer>	getIntegers() Retrieves a read/write structure for every integer field.
StructureModifier<org.bukkit.inventory.ItemStack[]>	getItemArrayModifier() Retrieves a read/write structure for arrays of ItemStacks.
StructureModifier<org.bukkit.inventory.ItemStack>	getItemModifier() Retrieves a read/write structure for ItemStack.
StructureModifier<java.lang.Long>	getLongs() Retrieves a read/write structure for every long field.
StructureModifier<java.lang.Object>	getModifier() Retrieves the generic structure modifier for this packet.
StructureModifier<NbtBase<?>>	getNbtModifier() Retrieves a read/write structure for NBT classes.
StructureModifier<java.util.List<ChunkPosition>>	getPositionCollectionModifier() Retrieves a read/write structure for collections of chunk positions.
StructureModifier<ChunkPosition>	getPositionModifier() Retrieves a read/write structure for chunk positions.
StructureModifier<java.lang.Short>	getShorts() Retrieves a read/write structure for every short field.
<T> StructureModifier<T>	getSpecificModifier(java.lang.Class<T> primitiveType) Retrieves a read/write structure for every field with the given type.
StructureModifier<java.lang.String[]>	getStringArrays() Retrieves a read/write structure for every String array field.
StructureModifier<java.lang.String>	getStrings() Retrieves a read/write structure for every String field.
StructureModifier<java.util.List<WrappedWatchableObject>>	getWatchableCollectionModifier() Retrieves a read/write structure for collections of watchable objects.
StructureModifier<org.bukkit.WorldType>	getWorldTypeModifier() Retrieves a read/write structure for the world type enum.
PacketContainer	shallowClone() Create a shallow copy of the current packet.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected int id

handle

protected transient java.lang.Object handle

structureModifier

protected transient StructureModifier<java.lang.Object> structureModifier

Constructor Detail

PacketContainer

public PacketContainer(int id)

Creates a packet container for a new packet.

Parameters:

id - - ID of the packet to create.

PacketContainer

public PacketContainer(int id,
               java.lang.Object handle)

Creates a packet container for an existing packet.

Parameters:

id - - ID of the given packet.

handle - - contained packet.

PacketContainer

public PacketContainer(int id,
               java.lang.Object handle,
               StructureModifier<java.lang.Object> structure)

Creates a packet container for an existing packet.

Parameters:

id - - ID of the given packet.

handle - - contained packet.

structure - - structure modifier.

PacketContainer

protected PacketContainer()

For serialization.

Method Detail

getHandle

public java.lang.Object getHandle()

Retrieves the underlying Minecraft packet.

Returns:

Underlying Minecraft packet.

getModifier

public StructureModifier<java.lang.Object> getModifier()

Retrieves the generic structure modifier for this packet.

Returns:

Structure modifier.

getSpecificModifier

public <T> StructureModifier<T> getSpecificModifier(java.lang.Class<T> primitiveType)

Retrieves a read/write structure for every field with the given type.

Parameters:

primitiveType - - the type to find.

Returns:

A modifier for this specific type.

getBytes

public StructureModifier<java.lang.Byte> getBytes()

Retrieves a read/write structure for every byte field.

Returns:

A modifier for every byte field.

getShorts

public StructureModifier<java.lang.Short> getShorts()

Retrieves a read/write structure for every short field.

Returns:

A modifier for every short field.

getIntegers

public StructureModifier<java.lang.Integer> getIntegers()

Retrieves a read/write structure for every integer field.

Returns:

A modifier for every integer field.

getLongs

public StructureModifier<java.lang.Long> getLongs()

Retrieves a read/write structure for every long field.

Returns:

A modifier for every long field.

getFloat

public StructureModifier<java.lang.Float> getFloat()

Retrieves a read/write structure for every float field.

Returns:

A modifier for every float field.

getDoubles

public StructureModifier<java.lang.Double> getDoubles()

Retrieves a read/write structure for every double field.

Returns:

A modifier for every double field.

getStrings

public StructureModifier<java.lang.String> getStrings()

Retrieves a read/write structure for every String field.

Returns:

A modifier for every String field.

getStringArrays

public StructureModifier<java.lang.String[]> getStringArrays()

Retrieves a read/write structure for every String array field.

Returns:

A modifier for every String array field.

getByteArrays

public StructureModifier<byte[]> getByteArrays()

Retrieves a read/write structure for every byte array field.

Returns:

A modifier for every byte array field.

getByteArraySerializer

public StreamSerializer getByteArraySerializer()

Retrieve a serializer for reading and writing ItemStacks stored in a byte array.

Returns:

A instance of the serializer.

getIntegerArrays

public StructureModifier<int[]> getIntegerArrays()

Retrieves a read/write structure for every int array field.

Returns:

A modifier for every int array field.

getItemModifier

public StructureModifier<org.bukkit.inventory.ItemStack> getItemModifier()

Retrieves a read/write structure for ItemStack.

This modifier will automatically marshall between the Bukkit ItemStack and the internal Minecraft ItemStack.

Returns:

A modifier for ItemStack fields.

getItemArrayModifier

public StructureModifier<org.bukkit.inventory.ItemStack[]> getItemArrayModifier()

Retrieves a read/write structure for arrays of ItemStacks.

This modifier will automatically marshall between the Bukkit ItemStack and the internal Minecraft ItemStack.

Returns:

A modifier for ItemStack array fields.

getWorldTypeModifier

public StructureModifier<org.bukkit.WorldType> getWorldTypeModifier()

Retrieves a read/write structure for the world type enum.

This modifier will automatically marshall between the Bukkit world type and the internal Minecraft world type.

Returns:

A modifier for world type fields.

getDataWatcherModifier

public StructureModifier<WrappedDataWatcher> getDataWatcherModifier()

Retrieves a read/write structure for data watchers.

Returns:

A modifier for data watchers.

getEntityModifier

public StructureModifier<org.bukkit.entity.Entity> getEntityModifier(org.bukkit.World world)

Retrieves a read/write structure for entity objects.

Note that entities are transmitted by integer ID, and the type may not be enough to distinguish between entities and other values. Thus, this structure modifier MAY return null or invalid entities for certain fields. Using the correct index is essential.

Returns:

A modifier entity types.

getPositionModifier

public StructureModifier<ChunkPosition> getPositionModifier()

Retrieves a read/write structure for chunk positions.

Returns:

A modifier for a ChunkPosition.

getNbtModifier

public StructureModifier<NbtBase<?>> getNbtModifier()

Retrieves a read/write structure for NBT classes.

Returns:

A modifier for NBT classes.

getPositionCollectionModifier

public StructureModifier<java.util.List<ChunkPosition>> getPositionCollectionModifier()

Retrieves a read/write structure for collections of chunk positions.

This modifier will automatically marshall between the visible ProtocolLib ChunkPosition and the internal Minecraft ChunkPosition.

Returns:

A modifier for ChunkPosition list fields.

getWatchableCollectionModifier

public StructureModifier<java.util.List<WrappedWatchableObject>> getWatchableCollectionModifier()

Retrieves a read/write structure for collections of watchable objects.

This modifier will automatically marshall between the visible WrappedWatchableObject and the internal Minecraft WatchableObject.

Returns:

A modifier for watchable object list fields.

getID

public int getID()

Retrieves the ID of this packet.

Returns:

Packet ID.

shallowClone

public PacketContainer shallowClone()

Create a shallow copy of the current packet.

This merely writes the content of each field to the new class directly, without performing any expensive copies.

Returns:

A shallow copy of the current packet.

deepClone

public PacketContainer deepClone()

Create a deep copy of the current packet.

This will perform a full copy of the entire object tree, only skipping known immutable objects and primitive types.

Note that the inflated buffers in packet 51 and 56 will be copied directly to save memory.

Returns:

A deep copy of the current packet.