Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.config.rev160406

Class IfmConfigBuilder

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

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

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

    • Constructor Detail

      • IfmConfigBuilder

        public IfmConfigBuilder()

      • IfmConfigBuilder

        public IfmConfigBuilder​(IfmConfig base)

    • Method Detail

      • getIfmStatsDefPollInterval

        public org.opendaylight.yangtools.yang.common.Uint16 getIfmStatsDefPollInterval()

      • isIfmStatsPollEnabled

        public java.lang.Boolean isIfmStatsPollEnabled()

      • isItmDirectTunnels

        public java.lang.Boolean isItmDirectTunnels()

      • augmentation

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

      • setIfmStatsDefPollInterval

        public IfmConfigBuilder setIfmStatsDefPollInterval​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setIfmStatsDefPollInterval

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

      • setIfmStatsPollEnabled

        public IfmConfigBuilder setIfmStatsPollEnabled​(java.lang.Boolean value)

      • setItmDirectTunnels

        public IfmConfigBuilder setItmDirectTunnels​(java.lang.Boolean value)

      • addAugmentation

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

      • removeAugmentation

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

      • build

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