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

Class UploadYangModelInputBuilder

java.lang.Object

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

All Implemented Interfaces:

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

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

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

   
     UploadYangModelInput createUploadYangModelInput(int fooXyzzy, int barBaz) {
         return new UploadYangModelInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

UploadYangModelInput, Builder

Constructor Summary

Constructors

Constructor	Description
UploadYangModelInputBuilder()
UploadYangModelInputBuilder(UploadYangModelInput base)
UploadYangModelInputBuilder(YangModel arg)
UploadYangModelInputBuilder(YangModelNameVersion arg)

Method Summary

Modifier and Type	Method	Description
UploadYangModelInputBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UploadYangModelInput> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UploadYangModelInput>> E$$	augmentation(Class<E$$> augmentationType)
UploadYangModelInput	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
String	getBody()
String	getName()
ModuleVersionType	getVersion()
UploadYangModelInputBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UploadYangModelInput>> augmentationType)	Remove an augmentation from this builder's product.
UploadYangModelInputBuilder	setBody(String value)
UploadYangModelInputBuilder	setName(String value)
UploadYangModelInputBuilder	setVersion(ModuleVersionType value)

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadYangModelInputBuilder

public UploadYangModelInputBuilder()

UploadYangModelInputBuilder

public UploadYangModelInputBuilder(YangModel arg)

UploadYangModelInputBuilder

public UploadYangModelInputBuilder(YangModelNameVersion arg)

UploadYangModelInputBuilder

public UploadYangModelInputBuilder(UploadYangModelInput 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:

• YangModel
• YangModelNameVersion

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

getBody

public String getBody()

getName

public String getName()

getVersion

public ModuleVersionType getVersion()

augmentation

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

setBody

public UploadYangModelInputBuilder setBody(String value)

setName

public UploadYangModelInputBuilder setName(String value)

setVersion

public UploadYangModelInputBuilder setVersion(ModuleVersionType value)

addAugmentation

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

Specified by:

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

Specified by:

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