Module org.pcap4j.core

Package org.pcap4j.packet

Class UdpPacket.Builder

java.lang.Object

org.pcap4j.packet.AbstractPacket.AbstractBuilder

org.pcap4j.packet.UdpPacket.Builder

All Implemented Interfaces:

Iterable<Packet.Builder>, ChecksumBuilder<UdpPacket>, LengthBuilder<UdpPacket>, Packet.Builder

Enclosing class:

UdpPacket

public static final class UdpPacket.Builder
extends AbstractPacket.AbstractBuilder
implements LengthBuilder<UdpPacket>, ChecksumBuilder<UdpPacket>

Since:

pcap4j 0.9.1

Field Summary

Fields

Modifier and Type	Field	Description
private short	checksum
private boolean	correctChecksumAtBuild
private boolean	correctLengthAtBuild
private InetAddress	dstAddr
private UdpPort	dstPort
private short	length
private Packet.Builder	payloadBuilder
private InetAddress	srcAddr
private UdpPort	srcPort

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(UdpPacket packet)

Method Summary

Modifier and Type	Method	Description
UdpPacket	build()	Build a packet object using values set to this object.
UdpPacket.Builder	checksum(short checksum)
UdpPacket.Builder	correctChecksumAtBuild(boolean correctChecksumAtBuild)
UdpPacket.Builder	correctLengthAtBuild(boolean correctLengthAtBuild)
UdpPacket.Builder	dstAddr(InetAddress dstAddr)	used for checksum calculation If the lower-layer packet is a IPv6 packet and the extension headers including a routing header, this parameter is that of the final destination.
UdpPacket.Builder	dstPort(UdpPort dstPort)
Packet.Builder	getPayloadBuilder()	Get the payload builder of this object.
UdpPacket.Builder	length(short length)
UdpPacket.Builder	payloadBuilder(Packet.Builder payloadBuilder)	Set the payload builder.
UdpPacket.Builder	srcAddr(InetAddress srcAddr)	used for checksum calculation.
UdpPacket.Builder	srcPort(UdpPort srcPort)

Methods inherited from class org.pcap4j.packet.AbstractPacket.AbstractBuilder

get, getOuterOf, iterator

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

Field Details

srcPort

private UdpPort srcPort

dstPort

private UdpPort dstPort

length

private short length

checksum

private short checksum

payloadBuilder

private Packet.Builder payloadBuilder

srcAddr

private InetAddress srcAddr

dstAddr

private InetAddress dstAddr

correctLengthAtBuild

private boolean correctLengthAtBuild

correctChecksumAtBuild

private boolean correctChecksumAtBuild

Constructor Details

Builder

public Builder()

Builder

public Builder(UdpPacket packet)

Parameters:

packet - packet

Method Details

srcPort

public UdpPacket.Builder srcPort(UdpPort srcPort)

Parameters:

srcPort - srcPort

Returns:

this Builder object for method chaining.

dstPort

public UdpPacket.Builder dstPort(UdpPort dstPort)

Parameters:

dstPort - dstPort

Returns:

this Builder object for method chaining.

length

public UdpPacket.Builder length(short length)

Parameters:

length - length

Returns:

this Builder object for method chaining.

checksum

public UdpPacket.Builder checksum(short checksum)

Parameters:

checksum - checksum

Returns:

this Builder object for method chaining.

payloadBuilder

public UdpPacket.Builder payloadBuilder(Packet.Builder payloadBuilder)

Description copied from interface: Packet.Builder

Set the payload builder.

Specified by:

payloadBuilder in interface Packet.Builder

Overrides:

payloadBuilder in class AbstractPacket.AbstractBuilder

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

Overrides:

getPayloadBuilder in class AbstractPacket.AbstractBuilder

Returns:

the payload builder of this object

srcAddr

public UdpPacket.Builder srcAddr(InetAddress srcAddr)

used for checksum calculation.

Parameters:

srcAddr - srcAddr

Returns:

this Builder object for method chaining.

dstAddr

public UdpPacket.Builder dstAddr(InetAddress dstAddr)

used for checksum calculation If the lower-layer packet is a IPv6 packet and the extension headers including a routing header, this parameter is that of the final destination. (i.e. the last element of the Routing header)

Parameters:

dstAddr - dstAddr

Returns:

this Builder object for method chaining.

correctLengthAtBuild

public UdpPacket.Builder correctLengthAtBuild(boolean correctLengthAtBuild)

Specified by:

correctLengthAtBuild in interface LengthBuilder<UdpPacket>

Parameters:

correctLengthAtBuild - correctLengthAtBuild

Returns:

LengthBuilder

correctChecksumAtBuild

public UdpPacket.Builder correctChecksumAtBuild(boolean correctChecksumAtBuild)

Specified by:

correctChecksumAtBuild in interface ChecksumBuilder<UdpPacket>

Parameters:

correctChecksumAtBuild - correctChecksumAtBuild

Returns:

ChecksumBuilder

build

public UdpPacket build()

Description copied from interface: Packet.Builder

Build a packet object using values set to this object.

Specified by:

build in interface ChecksumBuilder<UdpPacket>

Specified by:

build in interface LengthBuilder<UdpPacket>

Specified by:

build in interface Packet.Builder

Specified by:

build in class AbstractPacket.AbstractBuilder

Returns:

a new Packet object