Class PerInstanceBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<PerInstance>, org.opendaylight.yangtools.concepts.CheckedBuilder<PerInstance,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

    public class PerInstanceBuilder
    extends java.lang.Object
    implements org.opendaylight.yangtools.concepts.Builder<PerInstance>
    Class that builds PerInstanceBuilder 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:

         PerInstanceBuilder createTarget(int fooXyzzy, int barBaz) {
             return new PerInstanceBuilderBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • PerInstanceBuilder

        public PerInstanceBuilder()
      • PerInstanceBuilder

        public PerInstanceBuilder​(PerInstance base)
    • Method Detail

      • isApplyLabelPerInstance

        public java.lang.Boolean isApplyLabelPerInstance()
      • augmentation

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

        public PerInstanceBuilder setApplyLabelPerInstance​(java.lang.Boolean value)
      • addAugmentation

        public PerInstanceBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PerInstance>> augmentationType,
                                                  org.opendaylight.yangtools.yang.binding.Augmentation<PerInstance> augmentationValue)
      • removeAugmentation

        public PerInstanceBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PerInstance>> augmentationType)
      • build

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