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

Class DstNxNshc3CaseBuilder

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

   
     DstNxNshc3Case createDstNxNshc3Case(int fooXyzzy, int barBaz) {
         return new DstNxNshc3CaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • DstNxNshc3CaseBuilder

      public DstNxNshc3CaseBuilder()
      Construct an empty builder.

    • DstNxNshc3CaseBuilder

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

    • DstNxNshc3CaseBuilder

      public DstNxNshc3CaseBuilder(DstNxNshc3Case base)
      Construct a builder initialized with state from specified DstNxNshc3Case.
      Parameters:
      base - DstNxNshc3Case 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

    • getNxNshc3Dst

      public org.opendaylight.yangtools.yang.common.Empty getNxNshc3Dst()
      Return current value associated with the property corresponding to NxmNxNshc3Grouping.getNxNshc3Dst().
      Returns:
      current value

    • augmentation

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

    • setNxNshc3Dst

      public DstNxNshc3CaseBuilder setNxNshc3Dst(org.opendaylight.yangtools.yang.common.Empty value)
      Set the property corresponding to NxmNxNshc3Grouping.getNxNshc3Dst() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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