com.captainalm.lib.calmnet.packet.fragment

Class FragmentAllocatePacket

java.lang.Object

com.captainalm.lib.calmnet.packet.fragment.FragmentAllocatePacket

All Implemented Interfaces:

IPacket

public class FragmentAllocatePacket
extends java.lang.Object
implements IPacket

This class provides a packet for fragment allocation requesting. The response packet is: FragmentAllocationPacket.

Major ID: 254 Minor ID: 1

Author:

Captain ALM

Constructor Summary

Constructors

Constructor and Description
FragmentAllocatePacket(java.lang.Integer fragmentCount, java.util.UUID allocationID) Constructs a new FragmentAllocatePacket given the fragment count and allocation UUID.

Method Summary

Modifier and Type	Method and Description
java.util.UUID	getAllocationID() Gets the allocation ID or null.
java.lang.Integer	getFragmentCount() Gets the number of fragments or null.
PacketProtocolInformation	getProtocol() Gets the protocol information.
static PacketProtocolInformation	getTheProtocol() Gets the protocol information statically.
boolean	isValid() Gets if the packet is valid.
void	loadPayload(byte[] packetData) Loads the packet payload from save data.
byte[]	savePayload() Saves the packet payload to a byte array.

Methods inherited from class java.lang.Object

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

Constructor Detail

FragmentAllocatePacket

public FragmentAllocatePacket(java.lang.Integer fragmentCount,
                              java.util.UUID allocationID)

Constructs a new FragmentAllocatePacket given the fragment count and allocation UUID.

Parameters:

fragmentCount - The number of fragments to allocate.

allocationID - The allocation ID.

Throws:

java.lang.IllegalArgumentException - fragmentCount is less than 1.

Method Detail

isValid

public boolean isValid()

Gets if the packet is valid.

Specified by:

isValid in interface IPacket

Returns:

Is the packet valid?

getProtocol

public PacketProtocolInformation getProtocol()

Gets the protocol information.

Specified by:

getProtocol in interface IPacket

Returns:

The protocol information.

getTheProtocol

public static PacketProtocolInformation getTheProtocol()

Gets the protocol information statically.

Returns:

The protocol information.

savePayload

public byte[] savePayload()
                   throws PacketException

Saves the packet payload to a byte array.

Specified by:

savePayload in interface IPacket

Returns:

The packet payload data.

Throws:

PacketException - An Exception has occurred.

loadPayload

public void loadPayload(byte[] packetData)
                 throws PacketException

Loads the packet payload from save data.

Specified by:

loadPayload in interface IPacket

Parameters:

packetData - The packet payload data.

Throws:

java.lang.NullPointerException - The new store data is null.

PacketException - An Exception has occurred.

getFragmentCount

public java.lang.Integer getFragmentCount()

Gets the number of fragments or null.

Returns:

The number of fragments or null.

getAllocationID

public java.util.UUID getAllocationID()

Gets the allocation ID or null.

Returns:

The allocation ID or null.