Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ntfbench.payload.rev150709

Class NtfbenchBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ntfbench.payload.rev150709.NtfbenchBuilder
@Generated("mdsal-binding-generator") public class NtfbenchBuilder extends Object
Class that builds Ntfbench 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: 

   
     Ntfbench createNtfbench(int fooXyzzy, int barBaz) {
         return new NtfbenchBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • NtfbenchBuilder

      public NtfbenchBuilder()
      Construct an empty builder.

    • NtfbenchBuilder

      public NtfbenchBuilder(Payload arg)
      Construct a new builder initialized from specified Payload.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ntfbench.payload.rev150709.Payload from which the builder should be initialized

    • NtfbenchBuilder

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

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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

    • getPayload

      public Map<PayloadKey,Payload> getPayload()
      Return current value associated with the property corresponding to Payload.getPayload().
      Returns:
      current value

    • augmentation

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

    • setPayload

      public NtfbenchBuilder setPayload(Map<PayloadKey,Payload> values)
      Set the property corresponding to Payload.getPayload() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • addAugmentation

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