Module org.pcap4j.core

Package org.pcap4j.packet

Class AbstractPacket.AbstractBuilder

java.lang.Object

org.pcap4j.packet.AbstractPacket.AbstractBuilder

All Implemented Interfaces:

java.lang.Iterable<Packet.Builder>, Packet.Builder

Direct Known Subclasses:

AbstractPppPacket.Builder, ArpPacket.Builder, BsdLoopbackPacket.Builder, DnsPacket.Builder, Dot11ManagementPacket.Builder, Dot1qVlanTagPacket.Builder, EthernetPacket.Builder, GtpV1Packet.Builder, IcmpIdentifiablePacket.Builder, IcmpV4CommonPacket.Builder, IcmpV4InvokingPacketPacket.Builder, IcmpV6CommonPacket.Builder, IcmpV6HomeAgentAddressDiscoveryReplyPacket.Builder, IcmpV6HomeAgentAddressDiscoveryRequestPacket.Builder, IcmpV6InvokingPacketPacket.Builder, IcmpV6MobilePrefixAdvertisementPacket.Builder, IcmpV6MobilePrefixSolicitationPacket.Builder, IcmpV6NeighborAdvertisementPacket.Builder, IcmpV6NeighborSolicitationPacket.Builder, IcmpV6RedirectPacket.Builder, IcmpV6RouterAdvertisementPacket.Builder, IcmpV6RouterSolicitationPacket.Builder, IllegalPacket.Builder, IpV4Packet.Builder, IpV6ExtFragmentPacket.Builder, IpV6ExtOptionsPacket.Builder, IpV6ExtRoutingPacket.Builder, IpV6ExtUnknownPacket.Builder, IpV6Packet.Builder, LinuxSllPacket.Builder, LlcPacket.Builder, RadiotapPacket.Builder, SctpPacket.Builder, SimpleBuilder, SimplePacket.Builder, SnapPacket.Builder, Ssh2BinaryPacket.Builder, Ssh2DebugPacket.Builder, Ssh2DisconnectPacket.Builder, Ssh2IgnorePacket.Builder, Ssh2KexDhInitPacket.Builder, Ssh2KexDhReplyPacket.Builder, Ssh2KexInitPacket.Builder, Ssh2ServiceAcceptPacket.Builder, Ssh2ServiceRequestPacket.Builder, Ssh2UnimplementedPacket.Builder, Ssh2VersionExchangePacket.Builder, TcpPacket.Builder, UdpPacket.Builder

Enclosing class:

AbstractPacket

public abstract static class AbstractPacket.AbstractBuilder
extends java.lang.Object
implements Packet.Builder

Abstract packet builder class.

Version:

pcap4j 0.9.9

Constructor Summary

Constructors

Constructor	Description
AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
abstract Packet	build()	Build a packet object using values set to this object.
<T extends Packet.Builder> T	get(java.lang.Class<T> clazz)	Traverses this builder and its payload builder to find an object of the specified builder class and returns the object.
Packet.Builder	getOuterOf(java.lang.Class<? extends Packet.Builder> clazz)	Returns the outer builder object of a builder object get(clazz) returns.
Packet.Builder	getPayloadBuilder()	Get the payload builder of this object.
java.util.Iterator<Packet.Builder>	iterator()
AbstractPacket.AbstractBuilder	payloadBuilder(Packet.Builder payloadBuilder)	Set the payload builder.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AbstractBuilder

public AbstractBuilder()

Method Detail

iterator

public java.util.Iterator<Packet.Builder> iterator()

Specified by:

iterator in interface java.lang.Iterable<Packet.Builder>

get

public <T extends Packet.Builder> T get(java.lang.Class<T> clazz)

Description copied from interface: Packet.Builder

Traverses this builder and its payload builder to find an object of the specified builder class and returns the object. If there are more than one objects of the specified class in this object, this method returns the most outer one of them.

Specified by:

get in interface Packet.Builder

Type Parameters:

T - builder

Parameters:

clazz - the builder class of the object to get

Returns:

a builder object if found; otherwise null

getOuterOf

public Packet.Builder getOuterOf(java.lang.Class<? extends Packet.Builder> clazz)

Description copied from interface: Packet.Builder

Returns the outer builder object of a builder object get(clazz) returns.

Specified by:

getOuterOf in interface Packet.Builder

Parameters:

clazz - the builder class of the object whose outer builder object is what you want to get

Returns:

a builder object if found; otherwise null

payloadBuilder

public AbstractPacket.AbstractBuilder payloadBuilder(Packet.Builder payloadBuilder)

Description copied from interface: Packet.Builder

Set the payload builder.

Specified by:

payloadBuilder in interface Packet.Builder

Parameters:

payloadBuilder - a Builder object to set

Returns:

this Builder object for method chaining

getPayloadBuilder

public Packet.Builder getPayloadBuilder()

Description copied from interface: Packet.Builder

Get the payload builder of this object.

Specified by:

getPayloadBuilder in interface Packet.Builder

Returns:

the payload builder of this object

build

public abstract Packet build()

Description copied from interface: Packet.Builder

Build a packet object using values set to this object.

Specified by:

build in interface Packet.Builder

Returns:

a new Packet object