com.captainalm.lib.calmnet.packet

Class PacketProtocolInformation

java.lang.Object

com.captainalm.lib.calmnet.packet.PacketProtocolInformation

public class PacketProtocolInformation
extends java.lang.Object

This class provides the packet protocol information for IPacket.

Author:

Captain ALM

Constructor Summary

Constructors

Constructor and Description
PacketProtocolInformation() Constructs a new instance of PacketProtocolInformation.
PacketProtocolInformation(byte major, byte minor) Constructs a new instance of PacketProtocolInformation.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Gets whether this object equals the passed object.
int	getMajor() Gets the major protocol for the packet.
int	getMinor() Gets the minor protocol for the packet.
static PacketProtocolInformation	getProtocolInformation(java.io.InputStream inputStream) Gets the PacketProtocolInformation of the packet.
int	hashCode() Gets the hash code of the object.
static void	savePacketProtocolInformation(java.io.OutputStream outputStream, PacketProtocolInformation information) Saves the PacketProtocolInformation of the packet.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PacketProtocolInformation

public PacketProtocolInformation()

Constructs a new instance of PacketProtocolInformation. This is set to 0 Major, 0 Minor.

PacketProtocolInformation

public PacketProtocolInformation(byte major,
                                 byte minor)

Constructs a new instance of PacketProtocolInformation.

Parameters:

major - The major version.

minor - The minor version.

Method Detail

getMajor

public int getMajor()

Gets the major protocol for the packet.

Returns:

The major protocol.

getMinor

public int getMinor()

Gets the minor protocol for the packet.

Returns:

The minor protocol.

getProtocolInformation

public static PacketProtocolInformation getProtocolInformation(java.io.InputStream inputStream)
                                                        throws java.io.IOException

Gets the PacketProtocolInformation of the packet.

Parameters:

inputStream - The input stream for reading.

Returns:

The protocol information.

Throws:

java.lang.NullPointerException - The inputStream is null.

java.io.IOException - A stream exception occurs.

savePacketProtocolInformation

public static void savePacketProtocolInformation(java.io.OutputStream outputStream,
                                                 PacketProtocolInformation information)
                                          throws java.io.IOException

Saves the PacketProtocolInformation of the packet.

Parameters:

outputStream - The output stream for writing.

information - The protocol information.

Throws:

java.lang.NullPointerException - A parameter is null.

java.io.IOException - A stream exception occurs.

equals

public boolean equals(java.lang.Object o)

Gets whether this object equals the passed object.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to check.

Returns:

If the objects are equivalent.

hashCode

public int hashCode()

Gets the hash code of the object.

Overrides:

hashCode in class java.lang.Object

Returns:

The hash code of the object.