com.captainalm.lib.calmnet.packet.fragment

Class FragmentPIDAKNPacket

java.lang.Object

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

com.captainalm.lib.calmnet.packet.fragment.FragmentPIDAKNPacket

All Implemented Interfaces:

IAcknowledgement, IPacket

Direct Known Subclasses:

FragmentRetrySendPacket, FragmentSendCompletePacket

public abstract class FragmentPIDAKNPacket
extends FragmentPIDPacket
implements IAcknowledgement

This abstract base class provides the ability for packets to contain an ID and if it is an Acknowledgement.

Author:

Captain ALM

Constructor Summary

Constructors

Constructor and Description
FragmentPIDAKNPacket(java.lang.Integer packetID, java.lang.Boolean acknowledgement) Constructs a new FragmentPIDPacket given the packet ID and the acknowledgement value.

Method Summary

Modifier and Type	Method and Description
boolean	isAcknowledgement() Gets if the class instance is an Acknowledgement.
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

Methods inherited from interface com.captainalm.lib.calmnet.packet.IPacket

getProtocol

Constructor Detail

FragmentPIDAKNPacket

public FragmentPIDAKNPacket(java.lang.Integer packetID,
                            java.lang.Boolean acknowledgement)

Constructs a new FragmentPIDPacket given the packet ID and the acknowledgement value.

Parameters:

packetID - The packet ID.

acknowledgement - The acknowledgement value to use.

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?

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.

isAcknowledgement

public boolean isAcknowledgement()

Gets if the class instance is an Acknowledgement.

Specified by:

isAcknowledgement in interface IAcknowledgement

Returns:

If the class instance is an Acknowledgement.