Package org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.af.configuration.ipv4

Class MulticastBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Multicast>, org.opendaylight.yangtools.concepts.CheckedBuilder<Multicast,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class MulticastBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<Multicast>
    Class that builds MulticastBuilder 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: 

       
     MulticastBuilder createTarget(int fooXyzzy, int barBaz) {
         return new MulticastBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • MulticastBuilder

        public MulticastBuilder()

      • MulticastBuilder

        public MulticastBuilder​(Redistribute arg)

      • MulticastBuilder

        public MulticastBuilder​(Multicast base)

    • 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.cisco.params.xml.ns.yang.bgp.rev130715.Redistribute
        • org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.RouterAfConfig
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getAggregateAddress

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getAggregateAddress()

      • getAutoSummary

        public java.lang.Boolean getAutoSummary()

      • isAutoSummary

        @Deprecated(forRemoval=true)
public final java.lang.Boolean isAutoSummary()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getBgp

        public Bgp getBgp()

      • getDefaultMetric

        public org.opendaylight.yangtools.yang.common.Uint32 getDefaultMetric()

      • getDistance

        public org.opendaylight.yangtools.yang.common.Uint8 getDistance()

      • getNetwork

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getNetwork()

      • getProtocol

        public Protocol getProtocol()

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Multicast>> E$$ augmentation​(java.lang.Class<E$$> augmentationType)

      • setAggregateAddress

        public MulticastBuilder setAggregateAddress​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)

      • setAutoSummary

        public MulticastBuilder setAutoSummary​(java.lang.Boolean value)

      • setDefaultMetric

        public MulticastBuilder setDefaultMetric​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setDefaultMetric

        @Deprecated(forRemoval=true)
public MulticastBuilder setDefaultMetric​(java.lang.Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setDefaultMetric(Uint32) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setDistance

        public MulticastBuilder setDistance​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setDistance

        @Deprecated(forRemoval=true)
public MulticastBuilder setDistance​(java.lang.Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setDistance(Uint8) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setNetwork

        public MulticastBuilder setNetwork​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)

      • addAugmentation

        public MulticastBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Multicast> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        java.lang.NullPointerException - if augmentation is null

      • removeAugmentation

        public MulticastBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Multicast>> 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

      • build

        public Multicast build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Multicast>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Multicast,​java.lang.IllegalArgumentException>