com.captainalm.lib.calmnet.packet.fragment

Class FragmentPIDMSGPacket

java.lang.Object

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

com.captainalm.lib.calmnet.packet.fragment.FragmentPIDMSGPacket

All Implemented Interfaces:

IPacket

Direct Known Subclasses:

FragmentMessagePacket, FragmentMessageResponsePacket

public abstract class FragmentPIDMSGPacket
extends FragmentPIDPacket

This abstract base class provides the ability for packets to contain an ID, a Fragment ID and a payload.

Author:

Captain ALM

Constructor Summary

Constructors

Constructor and Description
FragmentPIDMSGPacket(java.lang.Integer packetID, java.lang.Integer fragmentID, byte[] payload) Constructs a new FragmentPIDMSGPacket given the packet ID, fragment ID and payload.

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getFragmentID() Gets the fragment ID or null.
byte[]	getFragmentMessage() Gets the fragment message byte array or null.
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

FragmentPIDMSGPacket

public FragmentPIDMSGPacket(java.lang.Integer packetID,
                            java.lang.Integer fragmentID,
                            byte[] payload)

Constructs a new FragmentPIDMSGPacket given the packet ID, fragment ID and payload.

Parameters:

packetID - The packet ID.

fragmentID - The fragment ID.

payload - The payload to store.

Throws:

java.lang.IllegalArgumentException - packetID or fragmentID 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.

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.

getFragmentMessage

public byte[] getFragmentMessage()

Gets the fragment message byte array or null.

Returns:

The byte array or null.

getFragmentID

public java.lang.Integer getFragmentID()

Gets the fragment ID or null.

Returns:

The fragment ID or null.