Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.mvpn.routes

Class MvpnRouteBuilder

  • @Generated("mdsal-binding-generator")
public class MvpnRouteBuilder
extends Object
    Class that builds MvpnRoute 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: 

       
     MvpnRoute createMvpnRoute(int fooXyzzy, int barBaz) {
         return new MvpnRouteBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • MvpnRouteBuilder

        public MvpnRouteBuilder()
        Construct an empty builder.

      • MvpnRouteBuilder

        public MvpnRouteBuilder​(MvpnBgpRibRoute arg)
        Construct a new builder initialized from specified MvpnBgpRibRoute.
        Parameters:
        arg - MvpnBgpRibRoute from which the builder should be initialized

      • MvpnRouteBuilder

        public MvpnRouteBuilder​(Mvpn arg)
        Construct a new builder initialized from specified Mvpn.
        Parameters:
        arg - Mvpn from which the builder should be initialized

      • MvpnRouteBuilder

        public MvpnRouteBuilder​(BgpRibRoute arg)
        Construct a new builder initialized from specified BgpRibRoute.
        Parameters:
        arg - BgpRibRoute from which the builder should be initialized

      • MvpnRouteBuilder

        public MvpnRouteBuilder​(BgpRibRoute arg)
        Construct a new builder initialized from specified BgpRibRoute.
        Parameters:
        arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pmsi.tunnel.rev200120.BgpRibRoute from which the builder should be initialized

      • MvpnRouteBuilder

        public MvpnRouteBuilder​(Route arg)
        Construct a new builder initialized from specified Route.
        Parameters:
        arg - Route from which the builder should be initialized

      • MvpnRouteBuilder

        public MvpnRouteBuilder​(PathIdGrouping arg)
        Construct a new builder initialized from specified PathIdGrouping.
        Parameters:
        arg - PathIdGrouping from which the builder should be initialized

      • MvpnRouteBuilder

        public MvpnRouteBuilder​(PathAttributes arg)
        Construct a new builder initialized from specified PathAttributes.
        Parameters:
        arg - PathAttributes from which the builder should be initialized

      • MvpnRouteBuilder

        public MvpnRouteBuilder​(MvpnRoute base)
        Construct a builder initialized with state from specified MvpnRoute.
        Parameters:
        base - MvpnRoute from which the builder should be initialized

    • Method Detail

      • key

        public MvpnRouteKey key()
        Return current value associated with the property corresponding to MvpnRoute.key().
        Returns:
        current value

      • getMvpnChoice

        public MvpnChoice getMvpnChoice()
        Return current value associated with the property corresponding to Mvpn.getMvpnChoice().
        Returns:
        current value

      • getRouteKey

        public String getRouteKey()
        Return current value associated with the property corresponding to Route.getRouteKey().
        Returns:
        current value

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MvpnRoute>> E$$ augmentation​(Class<E$$> augmentationType)
        Return the specified augmentation, if it is present in this builder.
        Type Parameters:
        E$$ - augmentation type
        Parameters:
        augmentationType - augmentation type class
        Returns:
        Augmentation object from this builder, or null if not present
        Throws:
        NullPointerException - if augmentType is null

      • addAugmentation

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