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

Class ConfigBuilder

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

       
     Config createConfig(int fooXyzzy, int barBaz) {
         return new ConfigBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • ConfigBuilder

        public ConfigBuilder()
        Construct an empty builder.

      • ConfigBuilder

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