com.captainalm.lib.calmnet.packet.fragment

Class FragmentAllocationPacket

java.lang.Object

com.captainalm.lib.calmnet.packet.fragment.FragmentPIDPacket

com.captainalm.lib.calmnet.packet.fragment.FragmentAllocationPacket

All Implemented Interfaces:

IPacket

public class FragmentAllocationPacket
extends FragmentPIDPacket

This class provides a packet for giving the allocated packetID as a response for FragmentAllocatePacket.

Major ID: 254 Minor ID: 2

Author:

Captain ALM

Constructor Summary

Constructors

Constructor and Description
FragmentAllocationPacket(java.lang.Integer packetID, java.util.UUID allocationID, java.lang.Boolean success) Constructs a new FragmentAllocationPacket given the packet ID, allocation ID and if it's successful.

Method Summary

Modifier and Type	Method and Description
boolean	allocationSuccessful() Checks if the allocation is successful.
java.util.UUID	getAllocationID() Gets the allocation ID 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 com.captainalm.lib.calmnet.packet.fragment.FragmentPIDPacket

getPacketID

Methods inherited from class java.lang.Object

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

Constructor Detail

FragmentAllocationPacket

public FragmentAllocationPacket(java.lang.Integer packetID,
                                java.util.UUID allocationID,
                                java.lang.Boolean success)

Constructs a new FragmentAllocationPacket given the packet ID, allocation ID and if it's successful.

Parameters:

packetID - The packet ID.

allocationID - The allocation ID.

success - The allocation was successful.

Throws:

java.lang.IllegalArgumentException - packetID is less than 0.

Method Detail

isValid

public boolean isValid()

Gets if the packet is valid.

Specified by:

isValid in interface IPacket

Overrides:

isValid in class FragmentPIDPacket

Returns:

Is the packet valid?

getProtocol

public PacketProtocolInformation getProtocol()

Gets the protocol information.

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.

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.

Parameters:

packetData - The packet payload data.

Throws:

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

PacketException - An Exception has occurred.

allocationSuccessful

public boolean allocationSuccessful()

Checks if the allocation is successful.

Returns:

If the allocation was successful.

getAllocationID

public java.util.UUID getAllocationID()

Gets the allocation ID or null.

Returns:

The allocation ID or null.