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

Class VendorXxx2Builder

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

   
     VendorXxx2 createVendorXxx2(int fooXyzzy, int barBaz) {
         return new VendorXxx2Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • VendorXxx2Builder

      public VendorXxx2Builder()
      Construct an empty builder.

    • VendorXxx2Builder

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

    • VendorXxx2Builder

      public VendorXxx2Builder(VendorXxx2 base)
      Construct a builder initialized with state from specified VendorXxx2.
      Parameters:
      base - VendorXxx2 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 VendorXxx2Builder setDosEkis(String value)
      Set the property corresponding to VendorXxxGrouping.getDosEkis() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • build

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