Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.of.migration.test.model.rev150210.aug.grouping.list1

Class List12Builder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.of.migration.test.model.rev150210.aug.grouping.list1.List12Builder
@Generated("mdsal-binding-generator") public class List12Builder extends Object
Class that builds List12 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: 

   
     List12 createList12(int fooXyzzy, int barBaz) {
         return new List12Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • List12Builder

      public List12Builder()
      Construct an empty builder.

    • List12Builder

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

  • Method Details

    • key

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

    • getAttrInt

      public Integer getAttrInt()
      Return current value associated with the property corresponding to List12.getAttrInt().
      Returns:
      current value

    • getAttrStr

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

    • augmentation

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

    • setAttrInt

      public List12Builder setAttrInt(Integer value)
      Set the property corresponding to List12.getAttrInt() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setAttrStr

      public List12Builder setAttrStr(String value)
      Set the property corresponding to List12.getAttrStr() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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