Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.subinterfaces.top.subinterfaces.subinterface

Class StateBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.subinterfaces.top.subinterfaces.subinterface.StateBuilder
@Generated("mdsal-binding-generator") public class StateBuilder extends Object
Class that builds State 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: 

   
     State createState(int fooXyzzy, int barBaz) {
         return new StateBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • StateBuilder

      public StateBuilder()
      Construct an empty builder.

    • StateBuilder

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

    • StateBuilder

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

    • StateBuilder

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

    • StateBuilder

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

    • StateBuilder

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

    • StateBuilder

      public StateBuilder(State base)
      Construct a builder initialized with state from specified State.
      Parameters:
      base - State from which the builder should be initialized

  • Method Details