Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.general.rev140714.general.extension.list.grouping

Class ExtensionListBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.general.rev140714.general.extension.list.grouping.ExtensionListBuilder
@Generated("mdsal-binding-generator") public class ExtensionListBuilder extends Object
Class that builds ExtensionList 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: 

   
     ExtensionList createExtensionList(int fooXyzzy, int barBaz) {
         return new ExtensionListBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ExtensionListBuilder

      public ExtensionListBuilder()
      Construct an empty builder.

    • ExtensionListBuilder

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

    • ExtensionListBuilder

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

    • getExtension

      public Extension getExtension()
      Return current value associated with the property corresponding to GeneralExtensionGrouping.getExtension().
      Returns:
      current value

    • getExtensionKey

      public ExtensionKey getExtensionKey()
      Return current value associated with the property corresponding to GeneralExtensionGrouping.getExtensionKey().
      Returns:
      current value

    • augmentation

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

    • setExtension

      public ExtensionListBuilder setExtension(Extension value)
      Set the property corresponding to GeneralExtensionGrouping.getExtension() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setExtensionKey

      public ExtensionListBuilder setExtensionKey(ExtensionKey value)
      Set the property corresponding to GeneralExtensionGrouping.getExtensionKey() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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