Package org.pcap4j.packet.factory.statik

Class StaticTcpOptionFactory

java.lang.Object

org.pcap4j.packet.factory.statik.StaticTcpOptionFactory

All Implemented Interfaces:

PacketFactory<TcpPacket.TcpOption,TcpOptionKind>

public final class StaticTcpOptionFactory
extends java.lang.Object
implements PacketFactory<TcpPacket.TcpOption,TcpOptionKind>

Since:

pcap4j 0.9.16

Author:

Kaito Yamada

Method Summary

Modifier and Type	Method	Description
static StaticTcpOptionFactory	getInstance()
TcpPacket.TcpOption	newInstance(byte[] rawData, int offset, int length)	This method is a variant of newInstance(byte[], int, int, TcpOptionKind...) and exists only for performance reason.
TcpPacket.TcpOption	newInstance(byte[] rawData, int offset, int length, TcpOptionKind number)	This method is a variant of newInstance(byte[], int, int, TcpOptionKind...) and exists only for performance reason.
TcpPacket.TcpOption	newInstance(byte[] rawData, int offset, int length, TcpOptionKind... numbers)	A factory method to build a packet or a packet field.
TcpPacket.TcpOption	newInstance(byte[] rawData, int offset, int length, TcpOptionKind number1, TcpOptionKind number2)	This method is a variant of newInstance(byte[], int, int, TcpOptionKind...) and exists only for performance reason.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static StaticTcpOptionFactory getInstance()

Returns:

the singleton instance of StaticTcpOptionFactory.

newInstance

public TcpPacket.TcpOption newInstance(byte[] rawData,
                                       int offset,
                                       int length)

This method is a variant of newInstance(byte[], int, int, TcpOptionKind...) and exists only for performance reason.

Parameters:

rawData - see PacketFactory.newInstance(byte[], int, int, N...).

offset - see PacketFactory.newInstance(byte[], int, int, N...).

length - see PacketFactory.newInstance(byte[], int, int, N...).

Returns:

see PacketFactory.newInstance(byte[], int, int, N...).

newInstance

public TcpPacket.TcpOption newInstance(byte[] rawData,
                                       int offset,
                                       int length,
                                       TcpOptionKind number)

This method is a variant of newInstance(byte[], int, int, TcpOptionKind...) and exists only for performance reason.

Parameters:

rawData - see PacketFactory.newInstance(byte[], int, int, N...).

offset - see PacketFactory.newInstance(byte[], int, int, N...).

length - see PacketFactory.newInstance(byte[], int, int, N...).

number - see PacketFactory.newInstance(byte[], int, int, N...).

Returns:

see PacketFactory.newInstance(byte[], int, int, N...).

newInstance

public TcpPacket.TcpOption newInstance(byte[] rawData,
                                       int offset,
                                       int length,
                                       TcpOptionKind number1,
                                       TcpOptionKind number2)

This method is a variant of newInstance(byte[], int, int, TcpOptionKind...) and exists only for performance reason.

Parameters:

rawData - see PacketFactory.newInstance(byte[], int, int, N...).

offset - see PacketFactory.newInstance(byte[], int, int, N...).

length - see PacketFactory.newInstance(byte[], int, int, N...).

number1 - see PacketFactory.newInstance(byte[], int, int, N...).

number2 - see PacketFactory.newInstance(byte[], int, int, N...).

Returns:

see PacketFactory.newInstance(byte[], int, int, N...).

newInstance

public TcpPacket.TcpOption newInstance(byte[] rawData,
                                       int offset,
                                       int length,
                                       TcpOptionKind... numbers)

Description copied from interface: PacketFactory

A factory method to build a packet or a packet field. The numbers are used as hints during the build. If no number is given, this method usually return an object which just wraps the specified part of the rawData without dissection. If one or more numbers are given, this method attempts to find a concrete class corresponding to the number for each of them in the order given. The class this method first find will be instantiated and returned. If no class is found, this method behaves in the same way as no number was given.

This method doesn't throw IllegalRawDataException. Instead, if an IllegalRawDataException occurred during a packet dissection, this instantiates IllegalRawDataPacket (if T is Packet) or IllegalRawDataHolder (if T is not Packet) and returns it.

Specified by:

newInstance in interface PacketFactory<TcpPacket.TcpOption,TcpOptionKind>

Parameters:

rawData - a byte array including data this method will use for building a T instance.

offset - offset of the data in the rawData.

length - length of the data. The object to be returned is not required to use or represent entire data. It means this length is not required to be exactly same as the returning object's length, but is required to be not smaller than it.

numbers - NamedNumber instances this method will refer to in order to decide which concrete class to instantiate during building a T instance.

Returns:

a new packet or packet field object.