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

     NxEncap createNxEncap(int fooXyzzy, int barBaz) {
         return new NxEncapBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())

This pattern is supported by the immutable nature of NxEncap, 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

    • NxEncapBuilder

      public NxEncapBuilder()
      Construct an empty builder.
    • NxEncapBuilder

      public NxEncapBuilder(PacketTypeFields arg)
      Construct a new builder initialized from specified PacketTypeFields.
      arg - PacketTypeFields from which the builder should be initialized
    • NxEncapBuilder

      public NxEncapBuilder(NxEncap base)
      Construct a builder initialized with state from specified NxEncap.
      base - NxEncap from which the builder should be initialized
  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
      Set fields from given grouping argument. Valid argument is instance of one of following types:
      arg - grouping object
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
    • getPacketType

      public org.opendaylight.yangtools.yang.common.Uint32 getPacketType()
      Return current value associated with the property corresponding to PacketTypeFields.getPacketType().
      current value
    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxEncap>> E$$ augmentation(Class<E$$> augmentationType)
      Return the specified augmentation, if it is present in this builder.
      Type Parameters:
      E$$ - augmentation type
      augmentationType - augmentation type class
      Augmentation object from this builder, or null if not present
      NullPointerException - if augmentType is null
    • setPacketType

      public NxEncapBuilder setPacketType(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to PacketTypeFields.getPacketType() to the specified value.
      value - desired value
      this builder
    • addAugmentation

      public NxEncapBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxEncap> augmentation)
      Add an augmentation to this builder's product.
      augmentation - augmentation to be added
      this builder
      NullPointerException - if augmentation is null
    • removeAugmentation

      public NxEncapBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxEncap>> augmentationType)
      Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
      augmentationType - augmentation type to be removed
      this builder
    • build

      public @NonNull NxEncap build()
      A new NxEncap instance.
      A new NxEncap instance.