Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.toaster.app.config.rev160503

Class ToasterAppConfigBuilder

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

       
     ToasterAppConfig createToasterAppConfig(int fooXyzzy, int barBaz) {
         return new ToasterAppConfigBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • ToasterAppConfigBuilder

        public ToasterAppConfigBuilder()

      • ToasterAppConfigBuilder

        public ToasterAppConfigBuilder​(ToasterAppConfig base)

    • Method Detail

      • getManufacturer

        public org.opendaylight.yang.gen.v1.http.netconfcentral.org.ns.toaster.rev091120.DisplayString getManufacturer()

      • getMaxMakeToastTries

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

      • getModelNumber

        public org.opendaylight.yang.gen.v1.http.netconfcentral.org.ns.toaster.rev091120.DisplayString getModelNumber()

      • augmentation

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

      • setManufacturer

        public ToasterAppConfigBuilder setManufacturer​(org.opendaylight.yang.gen.v1.http.netconfcentral.org.ns.toaster.rev091120.DisplayString value)

      • setMaxMakeToastTries

        public ToasterAppConfigBuilder setMaxMakeToastTries​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setModelNumber

        public ToasterAppConfigBuilder setModelNumber​(org.opendaylight.yang.gen.v1.http.netconfcentral.org.ns.toaster.rev091120.DisplayString value)

      • addAugmentation

        public ToasterAppConfigBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<ToasterAppConfig> 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 ToasterAppConfigBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ToasterAppConfig>> 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