Class MplsBosCaseBuilder

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

    @Generated("mdsal-binding-generator")
    public class MplsBosCaseBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<MplsBosCase>
    Class that builds MplsBosCaseBuilder 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:

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

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

      • MplsBosCaseBuilder

        public MplsBosCaseBuilder()
      • MplsBosCaseBuilder

        public MplsBosCaseBuilder​(MplsBosCase base)
    • Method Detail

      • getMplsBos

        public MplsBos getMplsBos()
      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MplsBosCase>> E$$ augmentation​(Class<E$$> augmentationType)
      • addAugmentation

        public MplsBosCaseBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<MplsBosCase> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        NullPointerException - if augmentation is null
      • removeAugmentation

        public MplsBosCaseBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MplsBosCase>> augmentationType)
        Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
        Parameters:
        augmentationType - augmentation type to be removed
        Returns:
        this builder