Package org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebfd.rev190219

Class BfdConfigBuilder

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

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

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

    • Constructor Detail

      • BfdConfigBuilder

        public BfdConfigBuilder()

      • BfdConfigBuilder

        public BfdConfigBuilder​(BfdConfig base)

    • Method Detail

      • getBfdEnabled

        public java.lang.Boolean getBfdEnabled()

      • isBfdEnabled

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

      • getDetectMult

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

      • getMinRx

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

      • getMinTx

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

      • getMultihop

        public java.lang.Boolean getMultihop()

      • isMultihop

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

      • augmentation

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

      • setBfdEnabled

        public BfdConfigBuilder setBfdEnabled​(java.lang.Boolean value)

      • setDetectMult

        public BfdConfigBuilder setDetectMult​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setDetectMult

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

      • setMinRx

        public BfdConfigBuilder setMinRx​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setMinRx

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

      • setMinTx

        public BfdConfigBuilder setMinTx​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setMinTx

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

      • setMultihop

        public BfdConfigBuilder setMultihop​(java.lang.Boolean value)

      • addAugmentation

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