Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.dst.choice.grouping.dst.choice

Class DstNxRegCaseBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.dst.choice.grouping.dst.choice.DstNxRegCaseBuilder
@Generated("mdsal-binding-generator") public class DstNxRegCaseBuilder extends Object
Class that builds DstNxRegCase 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: 

   
     DstNxRegCase createDstNxRegCase(int fooXyzzy, int barBaz) {
         return new DstNxRegCaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • DstNxRegCaseBuilder

      public DstNxRegCaseBuilder()
      Construct an empty builder.

    • DstNxRegCaseBuilder

      public DstNxRegCaseBuilder(NxmNxRegGrouping arg)
      Construct a new builder initialized from specified NxmNxRegGrouping.
      Parameters:
      arg - NxmNxRegGrouping from which the builder should be initialized

    • DstNxRegCaseBuilder

      public DstNxRegCaseBuilder(DstNxRegCase base)
      Construct a builder initialized with state from specified DstNxRegCase.
      Parameters:
      base - DstNxRegCase 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:
      Parameters:
      arg - grouping object
      Throws:
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

    • getNxReg

      public NxmNxReg getNxReg()
      Return current value associated with the property corresponding to NxmNxRegGrouping.getNxReg().
      Returns:
      current value

    • augmentation

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

    • setNxReg

      public DstNxRegCaseBuilder setNxReg(NxmNxReg value)
      Set the property corresponding to NxmNxRegGrouping.getNxReg() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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