java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.TransmitPacketInputBuilder

@Generated("mdsal-binding-generator") public class TransmitPacketInputBuilder extends Object
Class that builds TransmitPacketInput 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:

   
     TransmitPacketInput createTransmitPacketInput(int fooXyzzy, int barBaz) {
         return new TransmitPacketInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

This pattern is supported by the immutable nature of TransmitPacketInput, 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:
  • Constructor Details

    • TransmitPacketInputBuilder

      public TransmitPacketInputBuilder()
      Construct an empty builder.
    • TransmitPacketInputBuilder

      public TransmitPacketInputBuilder(NodeContextRef arg)
      Construct a new builder initialized from specified NodeContextRef.
      Parameters:
      arg - NodeContextRef from which the builder should be initialized
    • TransmitPacketInputBuilder

      public TransmitPacketInputBuilder(RawPacket arg)
      Construct a new builder initialized from specified RawPacket.
      Parameters:
      arg - RawPacket from which the builder should be initialized
    • TransmitPacketInputBuilder

      public TransmitPacketInputBuilder(ActionList arg)
      Construct a new builder initialized from specified ActionList.
      Parameters:
      arg - ActionList from which the builder should be initialized
    • TransmitPacketInputBuilder

      public TransmitPacketInputBuilder(TransmitPacketInput base)
      Construct a builder initialized with state from specified TransmitPacketInput.
      Parameters:
      base - TransmitPacketInput from which the builder should be initialized
  • Method Details