Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.openflow.rev181121.openflow.agent.top.agent

Class ConfigBuilder

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

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

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

    • Constructor Detail

      • ConfigBuilder

        public ConfigBuilder()

      • ConfigBuilder

        public ConfigBuilder​(Config 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:
        • OpenflowAgentConfig
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getBackoffInterval

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

      • getDatapathId

        public DatapathId getDatapathId()

      • getInactivityProbe

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

      • getMaxBackoff

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

      • augmentation

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

      • setBackoffInterval

        public ConfigBuilder setBackoffInterval​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setInactivityProbe

        public ConfigBuilder setInactivityProbe​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setMaxBackoff

        public ConfigBuilder setMaxBackoff​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • addAugmentation

        public ConfigBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Config> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        NullPointerException - if augmentation is null

      • removeAugmentation

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