Packet (NOVA-Core 0.1.0-SNAPSHOT API)

```
public interface Packet
```
A packet of data that is writable or readable.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default Packet`	`$less$less$less(java.lang.Object data)`
`int`	`getID()`
`default int`	`getType(java.lang.Class<?> compare)`
`Player`	`player()` The player sending the packet
`default <T> T`	`read(java.lang.Class<T> clazz)`
`boolean`	`readBoolean()` Gets a boolean at the current `readerIndex` and increases the `readerIndex` by `1` in this buffer.
`byte`	`readByte()` Gets a byte at the current `readerIndex` and increases the `readerIndex` by `1` in this buffer.
`byte[]`	`readBytes(int length)`
`char`	`readChar()` Gets a 2-byte UTF-16 character at the current `readerIndex` and increases the `readerIndex` by `2` in this buffer.
`default Data`	`readData()` Reads a `Data` type.
`double`	`readDouble()` Gets a 64-bit floating point number at the current `readerIndex` and increases the `readerIndex` by `8` in this buffer.
`default <E extends java.lang.Enum<E>> E`	`readEnum()`
`default <E extends java.lang.Enum<E>> E`	`readEnum(java.lang.Class<E> type)`
`float`	`readFloat()` Gets a 32-bit floating point number at the current `readerIndex` and increases the `readerIndex` by `4` in this buffer.
`int`	`readInt()` Gets a 32-bit integer at the current `readerIndex` and increases the `readerIndex` by `4` in this buffer.
`default <T> java.util.List<T>`	`readList()`
`long`	`readLong()` Gets a 64-bit integer at the current `readerIndex` and increases the `readerIndex` by `8` in this buffer.
`default <T> java.util.Optional<T>`	`readOptional()`
`default Syncable`	`readPacketHandler(Syncable handler)`
`default <T> java.util.Set<T>`	`readSet()`
`short`	`readShort()` Gets a 16-bit short integer at the current `readerIndex` and increases the `readerIndex` by `2` in this buffer.
`default java.lang.Object`	`readStorable()`
`java.lang.String`	`readString()`
`short`	`readUnsignedByte()` Gets an unsigned byte at the current `readerIndex` and increases the `readerIndex` by `1` in this buffer.
`long`	`readUnsignedInt()` Gets an unsigned 32-bit integer at the current `readerIndex` and increases the `readerIndex` by `4` in this buffer.
`default org.apache.commons.math3.geometry.euclidean.twod.Vector2D`	`readVector2D()`
`default org.apache.commons.math3.geometry.euclidean.threed.Vector3D`	`readVector3D()`
`Packet`	`setID(int id)` Sets the ID of this packet, allowing it to be sent accordingly.
`default Packet`	`write(java.lang.Object data)` Writes an arbitrary object, automatically finding the relevant class.
`Packet`	`writeBoolean(boolean value)` Sets the specified boolean at the current `writerIndex` and increases the `writerIndex` by `1` in this buffer.
`Packet`	`writeByte(int value)` Sets the specified byte at the current `writerIndex` and increases the `writerIndex` by `1` in this buffer.
`Packet`	`writeBytes(byte[] array)`
`Packet`	`writeChar(int value)` Sets the specified 2-byte UTF-16 character at the current `writerIndex` and increases the `writerIndex` by `2` in this buffer.
`default Packet`	`writeCollection(java.util.Collection<?> col)`
`default Packet`	`writeData(Data data)`
`Packet`	`writeDouble(double value)` Sets the specified 64-bit floating point number at the current `writerIndex` and increases the `writerIndex` by `8` in this buffer.
`default Packet`	`writeEnum(java.lang.Enum<?> data)`
`Packet`	`writeFloat(float value)` Sets the specified 32-bit floating point number at the current `writerIndex` and increases the `writerIndex` by `4` in this buffer.
`Packet`	`writeInt(int value)` Sets the specified 32-bit integer at the current `writerIndex` and increases the `writerIndex` by `4` in this buffer.
`Packet`	`writeLong(long value)` Sets the specified 64-bit long integer at the current `writerIndex` and increases the `writerIndex` by `8` in this buffer.
`default Packet`	`writeOptional(java.util.Optional<?> optional)`
`Packet`	`writeShort(int value)` Sets the specified 16-bit short integer at the current `writerIndex` and increases the `writerIndex` by `2` in this buffer.
`default Packet`	`writeStorable(Storable storable)`
`Packet`	`writeString(java.lang.String value)`

- Method Detail
  - getID
```
int getID()
```
    Returns:
    
    Gets the ID of this packet, used to determine what this packet is about.
  - setID
```
Packet setID(int id)
```
    Sets the ID of this packet, allowing it to be sent accordingly.
    
    Parameters:
    
    id - The packet ID
    
    Returns:
    
    The packet itself.
  - player
```
Player player()
```
    The player sending the packet
    
    Returns:
    
    The player sending the packet
  - write
```
default Packet write(java.lang.Object data)
```
    Writes an arbitrary object, automatically finding the relevant class.
    
    Parameters:
    
    data - Object to write
    
    Returns:
    
    This packet
  - $less$less$less
```
default Packet $less$less$less(java.lang.Object data)
```
  - writeBoolean
```
Packet writeBoolean(boolean value)
```
    Sets the specified boolean at the current writerIndex and increases the writerIndex by 1 in this buffer.
    
    Parameters:
    
    value - Data to write
    
    Returns:
    
    This packet
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if this.writableBytes is less than 1
  - writeByte
```
Packet writeByte(int value)
```
    Sets the specified byte at the current writerIndex and increases the writerIndex by 1 in this buffer. The 24 high-order bits of the specified value are ignored.
    
    Parameters:
    
    value - Data to write
    
    Returns:
    
    This packet
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if this.writableBytes is less than 1
  - writeShort
```
Packet writeShort(int value)
```
    Sets the specified 16-bit short integer at the current writerIndex and increases the writerIndex by 2 in this buffer. The 16 high-order bits of the specified value are ignored.
    
    Parameters:
    
    value - Data to write
    
    Returns:
    
    This packet
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if this.writableBytes is less than 2
  - writeInt
```
Packet writeInt(int value)
```
    Sets the specified 32-bit integer at the current writerIndex and increases the writerIndex by 4 in this buffer.
    
    Parameters:
    
    value - Data to write
    
    Returns:
    
    This packet
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if this.writableBytes is less than 4
  - writeLong
```
Packet writeLong(long value)
```
    Sets the specified 64-bit long integer at the current writerIndex and increases the writerIndex by 8 in this buffer.
    
    Parameters:
    
    value - Data to write
    
    Returns:
    
    This packet
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if this.writableBytes is less than 8
  - writeChar
```
Packet writeChar(int value)
```
    Sets the specified 2-byte UTF-16 character at the current writerIndex and increases the writerIndex by 2 in this buffer. The 16 high-order bits of the specified value are ignored.
    
    Parameters:
    
    value - Data to write
    
    Returns:
    
    This packet
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if this.writableBytes is less than 2
  - writeFloat
```
Packet writeFloat(float value)
```
    Sets the specified 32-bit floating point number at the current writerIndex and increases the writerIndex by 4 in this buffer.
    
    Parameters:
    
    value - Data to write
    
    Returns:
    
    This packet
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if this.writableBytes is less than 4
  - writeDouble
```
Packet writeDouble(double value)
```
    Sets the specified 64-bit floating point number at the current writerIndex and increases the writerIndex by 8 in this buffer.
    
    Parameters:
    
    value - Data to write
    
    Returns:
    
    This packet
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if this.writableBytes is less than 8
  - writeString
```
Packet writeString(java.lang.String value)
```
  - writeEnum
```
default Packet writeEnum(java.lang.Enum<?> data)
```
  - getType
```
default int getType(java.lang.Class<?> compare)
```
  - writeData
```
default Packet writeData(Data data)
```
  - writeStorable
```
default Packet writeStorable(Storable storable)
```
  - writeCollection
```
default Packet writeCollection(java.util.Collection<?> col)
```
  - writeOptional
```
default Packet writeOptional(java.util.Optional<?> optional)
```
  - writeBytes
```
Packet writeBytes(byte[] array)
```
  - readBytes
```
byte[] readBytes(int length)
```
  - readBoolean
```
boolean readBoolean()
```
    Gets a boolean at the current readerIndex and increases the readerIndex by 1 in this buffer.
    
    Returns:
    
    Data read from this packet
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if this.readableBytes is less than 1
  - readByte
```
byte readByte()
```
    Gets a byte at the current readerIndex and increases the readerIndex by 1 in this buffer.
    
    Returns:
    
    Data read from this packet
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if this.readableBytes is less than 1
  - readUnsignedByte
```
short readUnsignedByte()
```
    Gets an unsigned byte at the current readerIndex and increases the readerIndex by 1 in this buffer.
    
    Returns:
    
    Data read from this packet
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if this.readableBytes is less than 1
  - readShort
```
short readShort()
```
    Gets a 16-bit short integer at the current readerIndex and increases the readerIndex by 2 in this buffer.
    
    Returns:
    
    Data read from this packet
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if this.readableBytes is less than 2
  - readInt
```
int readInt()
```
    Gets a 32-bit integer at the current readerIndex and increases the readerIndex by 4 in this buffer.
    
    Returns:
    
    Data read from this packet
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if this.readableBytes is less than 4
  - readUnsignedInt
```
long readUnsignedInt()
```
    Gets an unsigned 32-bit integer at the current readerIndex and increases the readerIndex by 4 in this buffer.
    
    Returns:
    
    Data read from this packet
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if this.readableBytes is less than 4
  - readLong
```
long readLong()
```
    Gets a 64-bit integer at the current readerIndex and increases the readerIndex by 8 in this buffer.
    
    Returns:
    
    Data read from this packet
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if this.readableBytes is less than 8
  - readChar
```
char readChar()
```
    Gets a 2-byte UTF-16 character at the current readerIndex and increases the readerIndex by 2 in this buffer.
    
    Returns:
    
    Data read from this packet
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if this.readableBytes is less than 2
  - readFloat
```
float readFloat()
```
    Gets a 32-bit floating point number at the current readerIndex and increases the readerIndex by 4 in this buffer.
    
    Returns:
    
    Data read from this packet
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if this.readableBytes is less than 4
  - readDouble
```
double readDouble()
```
    Gets a 64-bit floating point number at the current readerIndex and increases the readerIndex by 8 in this buffer.
    
    Returns:
    
    Data read from this packet
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if this.readableBytes is less than 8
  - readString
```
java.lang.String readString()
```
  - readEnum
```
default <E extends java.lang.Enum<E>> E readEnum()
```
  - readEnum
```
default <E extends java.lang.Enum<E>> E readEnum(java.lang.Class<E> type)
```
  - readPacketHandler
```
default Syncable readPacketHandler(Syncable handler)
```
  - readData
```
default Data readData()
```
    Reads a Data type.
    
    Returns:
    
    The data type
  - readStorable
```
default java.lang.Object readStorable()
```
  - readList
```
default <T> java.util.List<T> readList()
```
  - readSet
```
default <T> java.util.Set<T> readSet()
```
  - readOptional
```
default <T> java.util.Optional<T> readOptional()
```
  - readVector2D
```
default org.apache.commons.math3.geometry.euclidean.twod.Vector2D readVector2D()
```
  - readVector3D
```
default org.apache.commons.math3.geometry.euclidean.threed.Vector3D readVector3D()
```
  - read
```
default <T> T read(java.lang.Class<T> clazz)
```

Interface Packet

Method Summary

Method Detail

getID

setID

player

write

$less$less$less

writeBoolean

writeByte

writeShort

writeInt

writeLong

writeChar

writeFloat

writeDouble

writeString

writeEnum

getType

writeData

writeStorable

writeCollection

writeOptional

writeBytes

readBytes

readBoolean

readByte

readUnsignedByte

readShort

readInt

readUnsignedInt

readLong

readChar

readFloat

readDouble

readString

readEnum

readEnum

readPacketHandler

readData

readStorable

readList

readSet

readOptional

readVector2D

readVector3D

read