org.johnnei.javatorrent.internal.utp.protocol

Enum PacketType

java.lang.Object

java.lang.Enum<PacketType>

org.johnnei.javatorrent.internal.utp.protocol.PacketType

All Implemented Interfaces:

Serializable, Comparable<PacketType>

public enum PacketType
extends Enum<PacketType>

The types of payload which can be contained in a UtpPacket

Enum Constant Summary

Enum Constants

Enum Constant and Description
DATA
FIN
RESET
STATE
SYN

Method Summary

Modifier and Type	Method and Description
Payload	createPayload(ByteBuffer data) Factory method to create payload instances.
static PacketType	getByType(int typeField)
byte	getTypeField()
static PacketType	valueOf(String name) Returns the enum constant of this type with the specified name.
static PacketType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DATA

public static final PacketType DATA

FIN

public static final PacketType FIN

STATE

public static final PacketType STATE

RESET

public static final PacketType RESET

SYN

public static final PacketType SYN

Method Detail

values

public static PacketType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PacketType c : PacketType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PacketType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getTypeField

public byte getTypeField()

Returns:

The byte value which represents this type.

createPayload

public Payload createPayload(ByteBuffer data)

Factory method to create payload instances.

Parameters:

data - The read data from the stream

Returns:

The newly created Payload instance.

getByType

public static PacketType getByType(int typeField)

Parameters:

typeField - The typeField value of the enum.

Returns:

The associated enum value.

Throws:

IllegalArgumentException - When the typeField does not exist.