Package org.opendaylight.yang.gen.v1.http.netconfcentral.org.ns.toaster.rev091120

Class ToasterBuilder

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

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

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

    • Constructor Detail

      • ToasterBuilder

        public ToasterBuilder()

      • ToasterBuilder

        public ToasterBuilder​(Toaster base)

    • Method Detail

      • getDarknessFactor

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

      • getToasterManufacturer

        public DisplayString getToasterManufacturer()

      • getToasterModelNumber

        public DisplayString getToasterModelNumber()

      • augmentation

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

      • setDarknessFactor

        public ToasterBuilder setDarknessFactor​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setDarknessFactor

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

      • addAugmentation

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