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

Class AsIdBuilder

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

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

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

    • Constructor Detail

      • AsIdBuilder

        public AsIdBuilder()

      • AsIdBuilder

        public AsIdBuilder​(AsId base)

    • Method Detail

      • getAnnounceFbit

        public java.lang.Boolean getAnnounceFbit()

      • isAnnounceFbit

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

      • getHoldtime

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

      • getKeepalive

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

      • getLocalAs

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

      • getRouterId

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

      • getStalepathTime

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

      • augmentation

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

      • setAnnounceFbit

        public AsIdBuilder setAnnounceFbit​(java.lang.Boolean value)

      • setHoldtime

        public AsIdBuilder setHoldtime​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setHoldtime

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

      • setKeepalive

        public AsIdBuilder setKeepalive​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setKeepalive

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

      • setLocalAs

        public AsIdBuilder setLocalAs​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setLocalAs

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

      • setRouterId

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

      • setStalepathTime

        public AsIdBuilder setStalepathTime​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setStalepathTime

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

      • addAugmentation

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