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

Class SrcNxIpv6SrcCaseBuilder

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

   
     SrcNxIpv6SrcCase createSrcNxIpv6SrcCase(int fooXyzzy, int barBaz) {
         return new SrcNxIpv6SrcCaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • SrcNxIpv6SrcCaseBuilder

      public SrcNxIpv6SrcCaseBuilder()
      Construct an empty builder.

    • SrcNxIpv6SrcCaseBuilder

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

    • SrcNxIpv6SrcCaseBuilder

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

    • getNxIpv6Src

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

    • augmentation

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

    • setNxIpv6Src

      public SrcNxIpv6SrcCaseBuilder setNxIpv6Src(org.opendaylight.yangtools.yang.common.Empty value)
      Set the property corresponding to NxmNxIpv6SrcGrouping.getNxIpv6Src() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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