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

Class ToasterBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.http.netconfcentral.org.ns.toaster.rev091120.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>

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 Summary

Constructors

Constructor and Description
ToasterBuilder()
ToasterBuilder(Toaster base)

Method Summary

Modifier and Type	Method and Description
ToasterBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Toaster>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Toaster> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Toaster>> E$$	augmentation(Class<E$$> augmentationType)
Toaster	build()
Long	getDarknessFactor()
DisplayString	getToasterManufacturer()
DisplayString	getToasterModelNumber()
Toaster.ToasterStatus	getToasterStatus()
ToasterBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Toaster>> augmentationType)
ToasterBuilder	setDarknessFactor(Long value)
ToasterBuilder	setToasterManufacturer(DisplayString value)
ToasterBuilder	setToasterModelNumber(DisplayString value)
ToasterBuilder	setToasterStatus(Toaster.ToasterStatus value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ToasterBuilder

public ToasterBuilder()

ToasterBuilder

public ToasterBuilder(Toaster base)

Method Detail

getDarknessFactor

public Long getDarknessFactor()

getToasterManufacturer

public DisplayString getToasterManufacturer()

getToasterModelNumber

public DisplayString getToasterModelNumber()

getToasterStatus

public Toaster.ToasterStatus getToasterStatus()

augmentation

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

setDarknessFactor

public ToasterBuilder setDarknessFactor(Long value)

setToasterManufacturer

public ToasterBuilder setToasterManufacturer(DisplayString value)

setToasterModelNumber

public ToasterBuilder setToasterModelNumber(DisplayString value)

setToasterStatus

public ToasterBuilder setToasterStatus(Toaster.ToasterStatus value)

addAugmentation

public ToasterBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Toaster>> augmentationType,
                                      org.opendaylight.yangtools.yang.binding.Augmentation<Toaster> augmentationValue)

removeAugmentation

public ToasterBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Toaster>> augmentationType)

build

public Toaster build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Toaster,IllegalArgumentException>