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

Class NestedListBuilder

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

   
     NestedList createNestedList(int fooXyzzy, int barBaz) {
         return new NestedListBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • NestedListBuilder

      public NestedListBuilder()
      Construct an empty builder.

    • NestedListBuilder

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

  • Method Details

    • key

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

    • getName

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

    • getType

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

    • augmentation

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

    • setName

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

    • setType

      public NestedListBuilder setType(String value)
      Set the property corresponding to NestedList.getType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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