Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.mvpn.mvpn.choice.shared.tree.join._case

Class SharedTreeJoinBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<SharedTreeJoin>, org.opendaylight.yangtools.concepts.CheckedBuilder<SharedTreeJoin,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class SharedTreeJoinBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<SharedTreeJoin>
    Class that builds SharedTreeJoin 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: 

       
     SharedTreeJoin createSharedTreeJoin(int fooXyzzy, int barBaz) {
         return new SharedTreeJoinBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • SharedTreeJoinBuilder

        public SharedTreeJoinBuilder()

      • SharedTreeJoinBuilder

        public SharedTreeJoinBuilder​(SharedTreeJoin base)

    • Method Detail

      • fieldsFrom

        public void fieldsFrom​(org.opendaylight.yangtools.yang.binding.DataObject arg)
        Set fields from given grouping argument. Valid argument is instance of one of following types:
        • CMulticastGrouping
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getCMulticast

        public CMulticast getCMulticast()

      • augmentation

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

      • addAugmentation

        public SharedTreeJoinBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<SharedTreeJoin> 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 SharedTreeJoinBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SharedTreeJoin>> 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