at.chrl.nutils.network.packet

Class BasePacket

java.lang.Object

at.chrl.nutils.network.packet.BasePacket

Direct Known Subclasses:

BaseClientPacket, BaseServerPacket

public abstract class BasePacket
extends Object

Basic superclass for packets.

Created on: 29.06.2009 17:59:25

Author:

Aquanox

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasePacket.PacketType Enumeration of packet types.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE_PATTERN Default packet string representation pattern.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasePacket(BasePacket.PacketType packetType) Constructs a new packet with given type.
protected	BasePacket(BasePacket.PacketType packetType, int opcode) Constructs a new packet with specified type and id.

Method Summary

Modifier and Type	Method and Description
int	getOpcode() Returns packet opcode.
String	getPacketName() Returns packet name.
BasePacket.PacketType	getPacketType() Returns packet type.
protected void	setOpcode(int opcode) Sets opcode of this packet.
String	toString() Returns string representation of this packet based on packet type, opcode and name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_PATTERN

public static final String TYPE_PATTERN

Default packet string representation pattern.

See Also:

Formatter, String.format(String, Object[]), Constant Field Values

Constructor Detail

BasePacket

protected BasePacket(BasePacket.PacketType packetType,
                     int opcode)

Constructs a new packet with specified type and id.

Parameters:

packetType - Type of packet

opcode - Id of packet

BasePacket

protected BasePacket(BasePacket.PacketType packetType)

Constructs a new packet with given type.
If this constructor is used, then setOpcode() must be used just after it.

Parameters:

packetType -

Method Detail

setOpcode

protected void setOpcode(int opcode)

Sets opcode of this packet.
NOTICE: Use only if BasePacket(PacketType) constructor was use

Parameters:

opcode -

getOpcode

public final int getOpcode()

Returns packet opcode.

Returns:

packet id

getPacketType

public final BasePacket.PacketType getPacketType()

Returns packet type.

Returns:

type of this packet.

See Also:

BasePacket.PacketType

getPacketName

public String getPacketName()

Returns packet name.

Actually packet name is a simple name of the underlying class.

Returns:

packet name

See Also:

Class.getSimpleName()

toString

public String toString()

Returns string representation of this packet based on packet type, opcode and name.

Overrides:

toString in class Object

Returns:

packet type string

See Also:

TYPE_PATTERN, Formatter, String.format(String, Object[])