Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.c.multicast.grouping

Class CMulticastBuilder

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

       
     CMulticast createCMulticast(int fooXyzzy, int barBaz) {
         return new CMulticastBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • CMulticastBuilder

        public CMulticastBuilder()
        Construct an empty builder.

      • CMulticastBuilder

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

      • CMulticastBuilder

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

    • Method Detail

      • getMulticastSource

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getMulticastSource()
        Return current value associated with the property corresponding to MulticastSourceRdGrouping.getMulticastSource().
        Returns:
        current value

      • getSourceAs

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getSourceAs()
        Return current value associated with the property corresponding to SourceAsGrouping.getSourceAs().
        Returns:
        current value

      • augmentation

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

      • setMulticastSource

        public CMulticastBuilder setMulticastSource​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
        Set the property corresponding to MulticastSourceRdGrouping.getMulticastSource() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setSourceAs

        public CMulticastBuilder setSourceAs​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
        Set the property corresponding to SourceAsGrouping.getSourceAs() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

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