Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.of.icmp.type.grouping

Class NxmOfIcmpTypeBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.of.icmp.type.grouping.NxmOfIcmpTypeBuilder
@Generated("mdsal-binding-generator") public class NxmOfIcmpTypeBuilder extends Object
Class that builds NxmOfIcmpType 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: 

   
     NxmOfIcmpType createNxmOfIcmpType(int fooXyzzy, int barBaz) {
         return new NxmOfIcmpTypeBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • NxmOfIcmpTypeBuilder

      public NxmOfIcmpTypeBuilder()
      Construct an empty builder.

    • NxmOfIcmpTypeBuilder

      public NxmOfIcmpTypeBuilder(NxmOfIcmpType base)
      Construct a builder initialized with state from specified NxmOfIcmpType.
      Parameters:
      base - NxmOfIcmpType from which the builder should be initialized

  • Method Details

    • getValue

      public org.opendaylight.yangtools.yang.common.Uint8 getValue()
      Return current value associated with the property corresponding to NxmOfIcmpType.getValue().
      Returns:
      current value

    • augmentation

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

    • setValue

      public NxmOfIcmpTypeBuilder setValue(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to NxmOfIcmpType.getValue() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

      public NxmOfIcmpTypeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfIcmpType> augmentation)
      Add an augmentation to this builder's product.
      Parameters:
      augmentation - augmentation to be added
      Returns:
      this builder
      Throws:
      NullPointerException - if augmentation is null

    • removeAugmentation

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

    • build

      public @NonNull NxmOfIcmpType build()
      A new NxmOfIcmpType instance.
      Returns:
      A new NxmOfIcmpType instance.