Package org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709

Class PacketInMessageBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<PacketInMessage>, org.opendaylight.yangtools.concepts.CheckedBuilder<PacketInMessage,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class PacketInMessageBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<PacketInMessage>
    Class that builds PacketInMessage instances. Overall design of the class is that of a fluent interface, where method chaining is used.

    In general, this class is supposed to be used like this template: 

       
     PacketInMessage createPacketInMessage(int fooXyzzy, int barBaz) {
         return new PacketInMessageBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

    This pattern is supported by the immutable nature of PacketInMessage, as instances can be freely passed around without worrying about synchronization issues.

    As a side note: method chaining results in:

    • very efficient Java bytecode, as the method invocation result, in this case the Builder reference, is on the stack, so further method invocations just need to fill method arguments for the next method invocation, which is terminated by build(), which is then returned from the method
    • better understanding by humans, as the scope of mutable state (the builder) is kept to a minimum and is very localized
    • better optimization opportunities, as the object scope is minimized in terms of invocation (rather than method) stack, making escape analysis a lot easier. Given enough compiler (JIT/AOT) prowess, the cost of th builder object can be completely eliminated
    See Also:
    PacketInMessage, Builder

    • Constructor Detail

      • PacketInMessageBuilder

        public PacketInMessageBuilder()

      • PacketInMessageBuilder

        public PacketInMessageBuilder​(PacketIn arg)

      • PacketInMessageBuilder

        public PacketInMessageBuilder​(RawPacket arg)

      • PacketInMessageBuilder

        public PacketInMessageBuilder​(OfHeader arg)

      • PacketInMessageBuilder

        public PacketInMessageBuilder​(PacketInMessage base)