com.captainalm.lib.calmnet.packet.factory

Interface IPacketFactory

All Known Implementing Classes:

CALMNETPacketFactory, CALMNETPacketFactoryWithPacket

public interface IPacketFactory

This interface provides the ability to construct IPackets given their PacketProtocolInformation.

Author:

Captain ALM

Method Summary

Modifier and Type	Method and Description
boolean	areStreamPacketsPreferred() Gets if getPacket(PacketProtocolInformation) prefers returning IStreamedPackets if possible.
IPacket	getPacket(PacketProtocolInformation information) Constructs a IPacket of the protocol specified by the passed PacketProtocolInformation instance.
void	setStreamPacketsPreferred(boolean preferred) Sets if getPacket(PacketProtocolInformation) prefers returning IStreamedPackets if possible.

Method Detail

getPacket

IPacket getPacket(PacketProtocolInformation information)

Constructs a IPacket of the protocol specified by the passed PacketProtocolInformation instance.

Parameters:

information - The protocol information to use.

Returns:

The constructed packet or null.

Throws:

java.lang.NullPointerException - The information is null.

areStreamPacketsPreferred

boolean areStreamPacketsPreferred()

Gets if getPacket(PacketProtocolInformation) prefers returning IStreamedPackets if possible.

Returns:

If streamed packets are preferred for construction.

setStreamPacketsPreferred

void setStreamPacketsPreferred(boolean preferred)

Sets if getPacket(PacketProtocolInformation) prefers returning IStreamedPackets if possible.

Parameters:

preferred - If streamed packets are preferred for construction.