Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice

Class SetNwDstCaseBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice.SetNwDstCaseBuilder
@Generated("mdsal-binding-generator") public class SetNwDstCaseBuilder extends Object
Class that builds SetNwDstCase 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: 

   
     SetNwDstCase createSetNwDstCase(int fooXyzzy, int barBaz) {
         return new SetNwDstCaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • SetNwDstCaseBuilder

      public SetNwDstCaseBuilder()
      Construct an empty builder.

    • SetNwDstCaseBuilder

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

  • Method Details

    • getSetNwDstAction

      public SetNwDstAction getSetNwDstAction()
      Return current value associated with the property corresponding to SetNwDstCase.getSetNwDstAction().
      Returns:
      current value

    • augmentation

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

    • setSetNwDstAction

      public SetNwDstCaseBuilder setSetNwDstAction(SetNwDstAction value)
      Set the property corresponding to SetNwDstCase.getSetNwDstAction() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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