Package org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918

Class UpdateMeterInputBuilder

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

       
     UpdateMeterInput createUpdateMeterInput(int fooXyzzy, int barBaz) {
         return new UpdateMeterInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • UpdateMeterInputBuilder

        public UpdateMeterInputBuilder()
        Construct an empty builder.

      • UpdateMeterInputBuilder

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

      • UpdateMeterInputBuilder

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

      • UpdateMeterInputBuilder

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

      • UpdateMeterInputBuilder

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