java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.general.rev140714.VendorXxx1Builder

@Generated("mdsal-binding-generator") public class VendorXxx1Builder extends Object
Class that builds VendorXxx1 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:

   
     VendorXxx1 createVendorXxx1(int fooXyzzy, int barBaz) {
         return new VendorXxx1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

    • VendorXxx1Builder

      public VendorXxx1Builder()
      Construct an empty builder.
    • VendorXxx1Builder

      public VendorXxx1Builder(VendorXxxGrouping arg)
      Construct a new builder initialized from specified VendorXxxGrouping.
      Parameters:
      arg - VendorXxxGrouping from which the builder should be initialized
    • VendorXxx1Builder

      public VendorXxx1Builder(VendorXxx1 base)
      Construct a builder initialized with state from specified VendorXxx1.
      Parameters:
      base - VendorXxx1 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
    • getDosEkis

      public String getDosEkis()
      Return current value associated with the property corresponding to VendorXxxGrouping.getDosEkis().
      Returns:
      current value
    • setDosEkis

      public VendorXxx1Builder setDosEkis(String value)
      Set the property corresponding to VendorXxxGrouping.getDosEkis() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • build

      public @NonNull VendorXxx1 build()
      A new VendorXxx1 instance.
      Returns:
      A new VendorXxx1 instance.