Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.monitoring.states

Class MonitoringStateBuilder

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

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

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

    • Constructor Detail

      • MonitoringStateBuilder

        public MonitoringStateBuilder()

      • MonitoringStateBuilder

        public MonitoringStateBuilder​(MonitoringState base)

    • Method Detail

      • getMonitorId

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

      • getMonitorKey

        public java.lang.String getMonitorKey()

      • getRequestCount

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

      • getResponsePendingCount

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

      • augmentation

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

      • setMonitorId

        public MonitoringStateBuilder setMonitorId​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setMonitorId

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

      • setRequestCount

        public MonitoringStateBuilder setRequestCount​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setRequestCount

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

      • setResponsePendingCount

        public MonitoringStateBuilder setResponsePendingCount​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setResponsePendingCount

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

      • addAugmentation

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