Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819

Class FlowCapableNodeBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<FlowCapableNode>, org.opendaylight.yangtools.concepts.CheckedBuilder<FlowCapableNode,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class FlowCapableNodeBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<FlowCapableNode>
    Class that builds FlowCapableNodeBuilder 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: 

       
     FlowCapableNodeBuilder createTarget(int fooXyzzy, int barBaz) {
         return new FlowCapableNodeBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • FlowCapableNodeBuilder

        public FlowCapableNodeBuilder()

      • FlowCapableNodeBuilder

        public FlowCapableNodeBuilder​(FlowNode arg)

      • FlowCapableNodeBuilder

        public FlowCapableNodeBuilder​(Desc arg)

      • FlowCapableNodeBuilder

        public FlowCapableNodeBuilder​(Tables arg)

      • FlowCapableNodeBuilder

        public FlowCapableNodeBuilder​(TableFeatures arg)

      • FlowCapableNodeBuilder

        public FlowCapableNodeBuilder​(Groups arg)

      • FlowCapableNodeBuilder

        public FlowCapableNodeBuilder​(Meters arg)

      • FlowCapableNodeBuilder

        public FlowCapableNodeBuilder​(FlowCapableNode base)