@Generated("mdsal-binding-generator") public class IgpActionsBuilder extends Object
Class that builds IgpActions 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:

     IgpActions createIgpActions(int fooXyzzy, int barBaz) {
         return new IgpActionsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())

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

    • IgpActionsBuilder

      public IgpActionsBuilder()
      Construct an empty builder.
    • IgpActionsBuilder

      public IgpActionsBuilder(IgpActions base)
      Construct a builder initialized with state from specified IgpActions.
      base - IgpActions from which the builder should be initialized
  • Method Details

    • empty

      public static @NonNull IgpActions empty()
      Get empty instance of IgpActions.
      An empty IgpActions
    • getSetTag

      public TagType getSetTag()
      Return current value associated with the property corresponding to IgpActions.getSetTag().
      current value
    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpActions>> E$$ augmentation(Class<E$$> augmentationType)
      Return the specified augmentation, if it is present in this builder.
      Type Parameters:
      E$$ - augmentation type
      augmentationType - augmentation type class
      Augmentation object from this builder, or null if not present
      NullPointerException - if augmentType is null
    • setSetTag

      public IgpActionsBuilder setSetTag(TagType value)
      Set the property corresponding to IgpActions.getSetTag() to the specified value.
      value - desired value
      this builder
    • addAugmentation

      public IgpActionsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IgpActions> augmentation)
      Add an augmentation to this builder's product.
      augmentation - augmentation to be added
      this builder
      NullPointerException - if augmentation is null
    • removeAugmentation

      public IgpActionsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpActions>> augmentationType)
      Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
      augmentationType - augmentation type to be removed
      this builder
    • build

      public @NonNull IgpActions build()
      A new IgpActions instance.
      A new IgpActions instance.