Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.openflow.rev181121

Class System1Builder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.openflow.rev181121.System1Builder
@Generated("mdsal-binding-generator") public class System1Builder extends Object
Class that builds System1 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: 

   
     System1 createSystem1(int fooXyzzy, int barBaz) {
         return new System1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • System1Builder

      public System1Builder()
      Construct an empty builder.

    • System1Builder

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

    • System1Builder

      public System1Builder(System1 base)
      Construct a builder initialized with state from specified System1.
      Parameters:
      base - System1 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

    • getOpenflow

      public Openflow getOpenflow()
      Return current value associated with the property corresponding to OpenflowTop.getOpenflow().
      Returns:
      current value

    • setOpenflow

      public System1Builder setOpenflow(Openflow value)
      Set the property corresponding to OpenflowTop.getOpenflow() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • build

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