Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.vpn.rev180329.l3vpn.ip.route

Class VpnRouteBuilder

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

       
     VpnRoute createVpnRoute(int fooXyzzy, int barBaz) {
         return new VpnRouteBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • VpnRouteBuilder

        public VpnRouteBuilder()
        Construct an empty builder.

      • VpnRouteBuilder

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

      • VpnRouteBuilder

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

      • VpnRouteBuilder

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

      • VpnRouteBuilder

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

      • VpnRouteBuilder

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

      • VpnRouteBuilder

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

    • Method Detail

      • key

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

      • getPrefix

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getPrefix()
        Return current value associated with the property corresponding to LabeledUnicast.getPrefix().
        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<VpnRoute>> 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

      • setPrefix

        public VpnRouteBuilder setPrefix​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
        Set the property corresponding to LabeledUnicast.getPrefix() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setRouteKey

        public VpnRouteBuilder setRouteKey​(String value)
        Set the property corresponding to Route.getRouteKey() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

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