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

Class OrderedListBuilder

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

   
     OrderedList createOrderedList(int fooXyzzy, int barBaz) {
         return new OrderedListBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • OrderedListBuilder

      public OrderedListBuilder()
      Construct an empty builder.

    • OrderedListBuilder

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

    • OrderedListBuilder

      public OrderedListBuilder(OrderedList base)
      Construct a builder initialized with state from specified OrderedList.
      Parameters:
      base - OrderedList 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 OrderedListKey key()
      Return current value associated with the property corresponding to OrderedList.key().
      Returns:
      current value

    • getName

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

    • getValue

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

    • augmentation

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

    • setName

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

    • setValue

      public OrderedListBuilder setValue(String value)
      Set the property corresponding to NameValue.getValue() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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