Package org.opendaylight.yang.gen.v1.urn.lighty.gnmi.yang.storage.rev210331

Class GnmiYangModelsBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.lighty.gnmi.yang.storage.rev210331.GnmiYangModelsBuilder

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Builder<GnmiYangModels>, org.opendaylight.yangtools.concepts.CheckedBuilder<GnmiYangModels,IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

@Generated("mdsal-binding-generator")
public class GnmiYangModelsBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<GnmiYangModels>

Class that builds GnmiYangModels 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:

   
     GnmiYangModels createGnmiYangModels(int fooXyzzy, int barBaz) {
         return new GnmiYangModelsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

GnmiYangModels, Builder

Constructor Summary

Constructors

Constructor	Description
GnmiYangModelsBuilder()
GnmiYangModelsBuilder(GnmiYangModels base)

Method Summary

Modifier and Type	Method	Description
GnmiYangModelsBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GnmiYangModels> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GnmiYangModels>> E$$	augmentation(Class<E$$> augmentationType)
GnmiYangModels	build()
Map<GnmiYangModelKey,GnmiYangModel>	getGnmiYangModel()
GnmiYangModelsBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GnmiYangModels>> augmentationType)	Remove an augmentation from this builder's product.
GnmiYangModelsBuilder	setGnmiYangModel(Map<GnmiYangModelKey,GnmiYangModel> values)

Methods inherited from class java.lang.Object

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

Constructor Detail

GnmiYangModelsBuilder

public GnmiYangModelsBuilder()

GnmiYangModelsBuilder

public GnmiYangModelsBuilder(GnmiYangModels base)

Method Detail

getGnmiYangModel

public Map<GnmiYangModelKey,GnmiYangModel> getGnmiYangModel()

augmentation

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

setGnmiYangModel

public GnmiYangModelsBuilder setGnmiYangModel(Map<GnmiYangModelKey,GnmiYangModel> values)

addAugmentation

public GnmiYangModelsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GnmiYangModels> 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 GnmiYangModelsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GnmiYangModels>> 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 GnmiYangModels build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.Builder<GnmiYangModels>

Specified by:

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