Class L3vpnMcastRoutesIpv6CaseBuilder

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

    public class L3vpnMcastRoutesIpv6CaseBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<L3vpnMcastRoutesIpv6Case>
    Class that builds L3vpnMcastRoutesIpv6Case 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:

         L3vpnMcastRoutesIpv6Case createL3vpnMcastRoutesIpv6Case(int fooXyzzy, int barBaz) {
             return new L3vpnMcastRoutesIpv6CaseBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • L3vpnMcastRoutesIpv6CaseBuilder

        public L3vpnMcastRoutesIpv6CaseBuilder()
      • L3vpnMcastRoutesIpv6CaseBuilder

        public L3vpnMcastRoutesIpv6CaseBuilder​(L3vpnMcastRoutesIpv6 arg)
    • 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:
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.L3vpnMcastRoutesIpv6
        arg - grouping object
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • augmentation

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

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