Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.monitor.profiles

Class MonitorProfileBuilder

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

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

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

    • Constructor Detail

      • MonitorProfileBuilder

        public MonitorProfileBuilder()

      • MonitorProfileBuilder

        public MonitorProfileBuilder​(BfdParams arg)

      • MonitorProfileBuilder

        public MonitorProfileBuilder​(MonitorProfile base)

    • 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.opendaylight.genius.alivenessmonitor.rev160411.MonitorProfileParams
        • org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.BfdParams
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • getCheckTnlKey

        public java.lang.String getCheckTnlKey()

      • getCpathDown

        public java.lang.String getCpathDown()

      • getDecayMinRx

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

      • getFailureThreshold

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

      • getForwardingIfRx

        public java.lang.String getForwardingIfRx()

      • getId

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

      • getMinRx

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

      • getMinTx

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

      • getMonitorInterval

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

      • getMonitorWindow

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

      • augmentation

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

      • setDecayMinRx

        public MonitorProfileBuilder setDecayMinRx​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setDecayMinRx

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

      • setFailureThreshold

        public MonitorProfileBuilder setFailureThreshold​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setFailureThreshold

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

      • setId

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

      • setMinRx

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

      • setMinRx

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

      • setMinTx

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

      • setMinTx

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

      • setMonitorInterval

        public MonitorProfileBuilder setMonitorInterval​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setMonitorInterval

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

      • setMonitorWindow

        public MonitorProfileBuilder setMonitorWindow​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setMonitorWindow

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

      • addAugmentation

        public MonitorProfileBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitorProfile>> augmentationType,
                                             org.opendaylight.yangtools.yang.binding.Augmentation<MonitorProfile> augmentationValue)

      • removeAugmentation

        public MonitorProfileBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitorProfile>> augmentationType)

      • build

        public MonitorProfile build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<MonitorProfile>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<MonitorProfile,​java.lang.IllegalArgumentException>