Module org.pcap4j.core
Package org.pcap4j.packet

Interface Packet.Builder

All Superinterfaces:
Iterable<Packet.Builder>
All Known Implementing Classes:
AbstractPacket.AbstractBuilder, AbstractPppPacket.Builder, ArpPacket.Builder, BsdLoopbackPacket.Builder, CompressedPacket.Builder, DnsPacket.Builder, Dot11ManagementPacket.Builder, Dot11ProbeRequestPacket.Builder, Dot1qVlanTagPacket.Builder, EncryptedPacket.Builder, EthernetPacket.Builder, FragmentedPacket.Builder, GtpV1Packet.Builder, HdlcPppPacket.Builder, IcmpIdentifiablePacket.Builder, IcmpV4CommonPacket.Builder, IcmpV4DestinationUnreachablePacket.Builder, IcmpV4EchoPacket.Builder, IcmpV4EchoReplyPacket.Builder, IcmpV4InformationReplyPacket.Builder, IcmpV4InformationRequestPacket.Builder, IcmpV4InvokingPacketPacket.Builder, IcmpV4ParameterProblemPacket.Builder, IcmpV4RedirectPacket.Builder, IcmpV4SourceQuenchPacket.Builder, IcmpV4TimeExceededPacket.Builder, IcmpV4TimestampPacket.Builder, IcmpV4TimestampReplyPacket.Builder, IcmpV6CommonPacket.Builder, IcmpV6DestinationUnreachablePacket.Builder, IcmpV6EchoReplyPacket.Builder, IcmpV6EchoRequestPacket.Builder, IcmpV6HomeAgentAddressDiscoveryReplyPacket.Builder, IcmpV6HomeAgentAddressDiscoveryRequestPacket.Builder, IcmpV6InvokingPacketPacket.Builder, IcmpV6MobilePrefixAdvertisementPacket.Builder, IcmpV6MobilePrefixSolicitationPacket.Builder, IcmpV6NeighborAdvertisementPacket.Builder, IcmpV6NeighborSolicitationPacket.Builder, IcmpV6PacketTooBigPacket.Builder, IcmpV6ParameterProblemPacket.Builder, IcmpV6RedirectPacket.Builder, IcmpV6RouterAdvertisementPacket.Builder, IcmpV6RouterSolicitationPacket.Builder, IcmpV6TimeExceededPacket.Builder, IllegalPacket.Builder, IpV4Packet.Builder, IpV6ExtDestinationOptionsPacket.Builder, IpV6ExtFragmentPacket.Builder, IpV6ExtHopByHopOptionsPacket.Builder, IpV6ExtOptionsPacket.Builder, IpV6ExtRoutingPacket.Builder, IpV6ExtUnknownPacket.Builder, IpV6Packet.Builder, LinuxSllPacket.Builder, LlcPacket.Builder, PppPacket.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, UnknownPacket.Builder
Enclosing interface:
Packet
public static interface Packet.Builder extends Iterable<Packet.Builder>
This interface is designed to be implemented by builder classes for packet objects.
Since:
pcap4j 0.9.1

  • Method Details

    • get

      <T extends Packet.Builder> T get(Class<T> clazz)
      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.
      Type Parameters:
      T - builder
      Parameters:
      clazz - the builder class of the object to get
      Returns:
      a builder object if found; otherwise null

    • getOuterOf

      Packet.Builder getOuterOf(Class<? extends Packet.Builder> clazz)
      Returns the outer builder object of a builder object get(clazz) returns.
      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

      Packet.Builder payloadBuilder(Packet.Builder payloadBuilder)
      Set the payload builder.
      Parameters:
      payloadBuilder - a Builder object to set
      Returns:
      this Builder object for method chaining

    • getPayloadBuilder

      Packet.Builder getPayloadBuilder()
      Get the payload builder of this object.
      Returns:
      the payload builder of this object

    • build

      Packet build()
      Build a packet object using values set to this object.
      Returns:
      a new Packet object