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

Class SrcNxNshc2CaseBuilder

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

   
     SrcNxNshc2Case createSrcNxNshc2Case(int fooXyzzy, int barBaz) {
         return new SrcNxNshc2CaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • SrcNxNshc2CaseBuilder

      public SrcNxNshc2CaseBuilder()
      Construct an empty builder.

    • SrcNxNshc2CaseBuilder

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

    • SrcNxNshc2CaseBuilder

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

    • getNxNshc2Dst

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

    • augmentation

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

    • setNxNshc2Dst

      public SrcNxNshc2CaseBuilder setNxNshc2Dst(org.opendaylight.yangtools.yang.common.Empty value)
      Set the property corresponding to NxmNxNshc2Grouping.getNxNshc2Dst() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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