Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.opendaylight.test.bug._3090.rev160101.root

Class ListInRootBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.opendaylight.test.bug._3090.rev160101.root.ListInRootBuilder
@Generated("mdsal-binding-generator") public class ListInRootBuilder extends Object
Class that builds ListInRoot 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: 

   
     ListInRoot createListInRoot(int fooXyzzy, int barBaz) {
         return new ListInRootBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ListInRootBuilder

      public ListInRootBuilder()
      Construct an empty builder.

    • ListInRootBuilder

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

  • Method Details

    • key

      public ListInRootKey key()
      Return current value associated with the property corresponding to ListInRoot.key().
      Returns:
      current value

    • getLeafA

      public String getLeafA()
      Return current value associated with the property corresponding to ListInRoot.getLeafA().
      Returns:
      current value

    • getLeafB

      public String getLeafB()
      Return current value associated with the property corresponding to ListInRoot.getLeafB().
      Returns:
      current value

    • getLeafC

      public String getLeafC()
      Return current value associated with the property corresponding to ListInRoot.getLeafC().
      Returns:
      current value

    • augmentation

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

    • withKey

      public ListInRootBuilder withKey(ListInRootKey key)
      Set the key value corresponding to ListInRoot.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setLeafA

      public ListInRootBuilder setLeafA(String value)
      Set the property corresponding to ListInRoot.getLeafA() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLeafB

      public ListInRootBuilder setLeafB(String value)
      Set the property corresponding to ListInRoot.getLeafB() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLeafC

      public ListInRootBuilder setLeafC(String value)
      Set the property corresponding to ListInRoot.getLeafC() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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