Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.store.rev140422

Class ListsBuilder

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

   
     Lists createLists(int fooXyzzy, int barBaz) {
         return new ListsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ListsBuilder

      public ListsBuilder()
      Construct an empty builder.

    • ListsBuilder

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

  • Method Details

    • empty

      public static @NonNull Lists empty()
      Get empty instance of Lists.
      Returns:
      An empty Lists

    • getOrderedContainer

      public OrderedContainer getOrderedContainer()
      Return current value associated with the property corresponding to Lists.getOrderedContainer().
      Returns:
      current value

    • getUnkeyedContainer

      public UnkeyedContainer getUnkeyedContainer()
      Return current value associated with the property corresponding to Lists.getUnkeyedContainer().
      Returns:
      current value

    • getUnorderedContainer

      public UnorderedContainer getUnorderedContainer()
      Return current value associated with the property corresponding to Lists.getUnorderedContainer().
      Returns:
      current value

    • augmentation

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

    • setOrderedContainer

      public ListsBuilder setOrderedContainer(OrderedContainer value)
      Set the property corresponding to Lists.getOrderedContainer() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setUnkeyedContainer

      public ListsBuilder setUnkeyedContainer(UnkeyedContainer value)
      Set the property corresponding to Lists.getUnkeyedContainer() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setUnorderedContainer

      public ListsBuilder setUnorderedContainer(UnorderedContainer value)
      Set the property corresponding to Lists.getUnorderedContainer() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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