Package org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.neighbors.bgp.neighbor.af.specific.config.l2vpn

Class VplsBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Vpls>, org.opendaylight.yangtools.concepts.CheckedBuilder<Vpls,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class VplsBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<Vpls>
    Class that builds VplsBuilder 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: 

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

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

    • 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.SlowPeerConfig
        • org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.NeighbourBaseAfConfig
        • org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.NeighbourCommonAfConfig
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • getAdvertisementInterval

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

      • getDetection

        public Detection getDetection()

      • getMaximumPrefix

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

      • getPrefixList

        public java.lang.String getPrefixList()

      • getSoo

        public java.lang.String getSoo()

      • getWeight

        public org.opendaylight.yangtools.yang.common.Uint16 getWeight()

      • isActive

        public java.lang.Boolean isActive()

      • isAllowasIn

        public java.lang.Boolean isAllowasIn()

      • isNextHopSelf

        public java.lang.Boolean isNextHopSelf()

      • isNextHopUnchanged

        public java.lang.Boolean isNextHopUnchanged()

      • isRouteReflectorClient

        public java.lang.Boolean isRouteReflectorClient()

      • isSoftReconfiguration

        public java.lang.Boolean isSoftReconfiguration()

      • augmentation

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

      • setAdvertisementInterval

        public VplsBuilder setAdvertisementInterval​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setAdvertisementInterval

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

      • setMaximumPrefix

        public VplsBuilder setMaximumPrefix​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setMaximumPrefix

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

      • setPrefixList

        public VplsBuilder setPrefixList​(java.lang.String value)

      • setSoo

        public VplsBuilder setSoo​(java.lang.String value)

      • setWeight

        public VplsBuilder setWeight​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setWeight

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

      • setActive

        public VplsBuilder setActive​(java.lang.Boolean value)

      • setAllowasIn

        public VplsBuilder setAllowasIn​(java.lang.Boolean value)

      • setNextHopSelf

        public VplsBuilder setNextHopSelf​(java.lang.Boolean value)

      • setNextHopUnchanged

        public VplsBuilder setNextHopUnchanged​(java.lang.Boolean value)

      • setRouteReflectorClient

        public VplsBuilder setRouteReflectorClient​(java.lang.Boolean value)

      • setSoftReconfiguration

        public VplsBuilder setSoftReconfiguration​(java.lang.Boolean value)

      • addAugmentation

        public VplsBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Vpls> 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

      • addAugmentation

        @Deprecated(forRemoval=true)
public VplsBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vpls>> augmentationType,
                                   org.opendaylight.yangtools.yang.binding.Augmentation<Vpls> augmentationValue)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use either addAugmentation(Augmentation) or removeAugmentation(Class) instead.
        Add or remove an augmentation to this builder's product.
        Parameters:
        augmentationType - augmentation type to be added or removed
        augmentationValue - augmentation value, null if the augmentation type should be removed
        Returns:
        this builder

      • removeAugmentation

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