Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.nshc._2.grouping

Class NxmNxNshc2Builder

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

   
     NxmNxNshc2 createNxmNxNshc2(int fooXyzzy, int barBaz) {
         return new NxmNxNshc2Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • NxmNxNshc2Builder

      public NxmNxNshc2Builder()
      Construct an empty builder.

    • NxmNxNshc2Builder

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

  • Method Details

    • empty

      public static @NonNull NxmNxNshc2 empty()
      Get empty instance of NxmNxNshc2.
      Returns:
      An empty NxmNxNshc2

    • getMask

      public org.opendaylight.yangtools.yang.common.Uint32 getMask()
      Return current value associated with the property corresponding to NxmNxNshc2.getMask().
      Returns:
      current value

    • getValue

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

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshc2>> 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

    • setMask

      public NxmNxNshc2Builder setMask(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to NxmNxNshc2.getMask() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setValue

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

    • addAugmentation

      public NxmNxNshc2Builder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshc2> 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 NxmNxNshc2Builder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshc2>> 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 NxmNxNshc2 build()
      A new NxmNxNshc2 instance.
      Returns:
      A new NxmNxNshc2 instance.