Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413

Class UnlockOutputBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<UnlockOutput>, org.opendaylight.yangtools.concepts.CheckedBuilder<UnlockOutput,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class UnlockOutputBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<UnlockOutput>
    Class that builds UnlockOutputBuilder 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: 

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

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

    • Constructor Detail

      • UnlockOutputBuilder

        public UnlockOutputBuilder()

      • UnlockOutputBuilder

        public UnlockOutputBuilder​(UnlockOutput base)

    • Method Detail

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UnlockOutput>> E$$ augmentation​(java.lang.Class<E$$> augmentationType)

      • addAugmentation

        public UnlockOutputBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UnlockOutput>> augmentationType,
                                           org.opendaylight.yangtools.yang.binding.Augmentation<UnlockOutput> augmentationValue)

      • removeAugmentation

        public UnlockOutputBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UnlockOutput>> augmentationType)

      • build

        public UnlockOutput build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<UnlockOutput>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<UnlockOutput,​java.lang.IllegalArgumentException>