Package org.opendaylight.yang.gen.v1.opendaylight.test.bug._2562.namespace.rev160101.root

Class FoorootBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.opendaylight.test.bug._2562.namespace.rev160101.root.FoorootBuilder
@Generated("mdsal-binding-generator") public class FoorootBuilder extends Object
Class that builds Fooroot 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: 

   
     Fooroot createFooroot(int fooXyzzy, int barBaz) {
         return new FoorootBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • FoorootBuilder

      public FoorootBuilder()
      Construct an empty builder.

    • FoorootBuilder

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

  • Method Details

    • getBarroot

      public Map<BarrootKey,Barroot> getBarroot()
      Return current value associated with the property corresponding to Fooroot.getBarroot().
      Returns:
      current value

    • augmentation

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

    • setBarroot

      public FoorootBuilder setBarroot(Map<BarrootKey,Barroot> values)
      Set the property corresponding to Fooroot.getBarroot() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • addAugmentation

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