Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list

Class TopLevelListBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelListBuilder
@Generated("mdsal-binding-generator") public class TopLevelListBuilder extends Object
Class that builds TopLevelList 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: 

   
     TopLevelList createTopLevelList(int fooXyzzy, int barBaz) {
         return new TopLevelListBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • TopLevelListBuilder

      public TopLevelListBuilder()
      Construct an empty builder.

    • TopLevelListBuilder

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

  • Method Details

    • key

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

    • getName

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

    • getNestedList

      public List<NestedList> getNestedList()
      Return current value associated with the property corresponding to TopLevelList.getNestedList().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TopLevelList>> 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 TopLevelListBuilder withKey(TopLevelListKey key)
      Set the key value corresponding to TopLevelList.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setName

      public TopLevelListBuilder setName(String value)
      Set the property corresponding to TopLevelList.getName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNestedList

      public TopLevelListBuilder setNestedList(List<NestedList> values)
      Set the property corresponding to TopLevelList.getNestedList() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • addAugmentation

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