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

Class MonitoringInfoBuilder

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

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

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

    • Constructor Detail

      • MonitoringInfoBuilder

        public MonitoringInfoBuilder()

      • MonitoringInfoBuilder

        public MonitoringInfoBuilder​(MonitorParams arg)

      • MonitoringInfoBuilder

        public MonitoringInfoBuilder​(MonitoringInfo 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.MonitorParams
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getId

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

      • getProfileId

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

      • getSource

        public Source getSource()

      • augmentation

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

      • setId

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

      • setProfileId

        public MonitoringInfoBuilder setProfileId​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setProfileId

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

      • addAugmentation

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