Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities

Class RouteRefreshCapabilityBuilder

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

       
     RouteRefreshCapability createRouteRefreshCapability(int fooXyzzy, int barBaz) {
         return new RouteRefreshCapabilityBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • RouteRefreshCapabilityBuilder

        public RouteRefreshCapabilityBuilder()
        Construct an empty builder.

      • RouteRefreshCapabilityBuilder

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

    • Method Detail

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteRefreshCapability>> 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

      • removeAugmentation

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