Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731

Class ExperimenterMessageBuilder

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

       
     ExperimenterMessage createExperimenterMessage(int fooXyzzy, int barBaz) {
         return new ExperimenterMessageBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • ExperimenterMessageBuilder

        public ExperimenterMessageBuilder()
        Construct an empty builder.

      • ExperimenterMessageBuilder

        public ExperimenterMessageBuilder​(ExperimenterOfMessage arg)
        Construct a new builder initialized from specified ExperimenterOfMessage.
        Parameters:
        arg - ExperimenterOfMessage from which the builder should be initialized

      • ExperimenterMessageBuilder

        public ExperimenterMessageBuilder​(OfHeader arg)
        Construct a new builder initialized from specified OfHeader.
        Parameters:
        arg - OfHeader from which the builder should be initialized

      • ExperimenterMessageBuilder

        public ExperimenterMessageBuilder​(ExperimenterCore arg)
        Construct a new builder initialized from specified ExperimenterCore.
        Parameters:
        arg - ExperimenterCore from which the builder should be initialized

      • ExperimenterMessageBuilder

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