Package org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.bgp.multipathcontainer

Class MultipathBuilder

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

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

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

    • Constructor Detail

      • MultipathBuilder

        public MultipathBuilder()

      • MultipathBuilder

        public MultipathBuilder​(Multipath base)

    • Method Detail

      • getAfi

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

      • getMultipathEnabled

        public java.lang.Boolean getMultipathEnabled()

      • isMultipathEnabled

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

      • getSafi

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

      • augmentation

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

      • setAfi

        public MultipathBuilder setAfi​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setAfi

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

      • setMultipathEnabled

        public MultipathBuilder setMultipathEnabled​(java.lang.Boolean value)

      • setSafi

        public MultipathBuilder setSafi​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setSafi

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

      • addAugmentation

        public MultipathBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Multipath> 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 MultipathBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Multipath>> 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 Multipath build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Multipath>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Multipath,​java.lang.IllegalArgumentException>