Package org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.bgp.af.vpn.instance.config.bgppeers

Class BgpPeerBuilder

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

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

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

    • Constructor Detail

      • BgpPeerBuilder

        public BgpPeerBuilder()

      • BgpPeerBuilder

        public BgpPeerBuilder​(BgpPeer base)

    • Method Detail

      • getDescription

        public java.lang.String getDescription()

      • getGroupName

        public java.lang.String getGroupName()

      • getPeerAddr

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

      • getRemoteAs

        public java.lang.String getRemoteAs()

      • getSoo

        public java.lang.String getSoo()

      • getSubstituteAsEnable

        public java.lang.Boolean getSubstituteAsEnable()

      • isSubstituteAsEnable

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

      • augmentation

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

      • setDescription

        public BgpPeerBuilder setDescription​(java.lang.String value)

      • setGroupName

        public BgpPeerBuilder setGroupName​(java.lang.String value)

      • setPeerAddr

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

      • setRemoteAs

        public BgpPeerBuilder setRemoteAs​(java.lang.String value)

      • setSubstituteAsEnable

        public BgpPeerBuilder setSubstituteAsEnable​(java.lang.Boolean value)

      • addAugmentation

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