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

Class Contlist1Builder

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

   
     Contlist1 createContlist1(int fooXyzzy, int barBaz) {
         return new Contlist1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Contlist1Builder

      public Contlist1Builder()
      Construct an empty builder.

    • Contlist1Builder

      public Contlist1Builder(EnumGrouping arg)
      Construct a new builder initialized from specified EnumGrouping.
      Parameters:
      arg - EnumGrouping from which the builder should be initialized

    • Contlist1Builder

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

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
      Set fields from given grouping argument. Valid argument is instance of one of following types:
      Parameters:
      arg - grouping object
      Throws:
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

    • key

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

    • getAttrEnum

      public CustomEnum getAttrEnum()
      Return current value associated with the property corresponding to EnumGrouping.getAttrEnum().
      Returns:
      current value

    • getAttrStr

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

    • augmentation

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

    • setAttrEnum

      public Contlist1Builder setAttrEnum(CustomEnum value)
      Set the property corresponding to EnumGrouping.getAttrEnum() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setAttrStr

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

    • addAugmentation

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