Class UploadYangModelInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.lighty.gnmi.yang.storage.rev210331.UploadYangModelInputBuilder
-
@Generated("mdsal-binding-generator") public class UploadYangModelInputBuilder extends Object
Class that buildsUploadYangModelInputinstances. 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
- 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
-
-
Constructor Summary
Constructors Constructor Description UploadYangModelInputBuilder()Construct an empty builder.UploadYangModelInputBuilder(UploadYangModelInput base)Construct a builder initialized with state from specifiedUploadYangModelInput.UploadYangModelInputBuilder(YangModel arg)Construct a new builder initialized from specifiedYangModel.UploadYangModelInputBuilder(YangModelNameVersion arg)Construct a new builder initialized from specifiedYangModelNameVersion.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UploadYangModelInputBuilderaddAugmentation(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)Return the specified augmentation, if it is present in this builder.@NonNull UploadYangModelInputbuild()A newUploadYangModelInputinstance.voidfieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)Set fields from given grouping argument.StringgetBody()Return current value associated with the property corresponding toYangModel.getBody().StringgetName()Return current value associated with the property corresponding toYangModelNameVersion.getName().ModuleVersionTypegetVersion()Return current value associated with the property corresponding toYangModelNameVersion.getVersion().UploadYangModelInputBuilderremoveAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UploadYangModelInput>> augmentationType)Remove an augmentation from this builder's product.UploadYangModelInputBuildersetBody(String value)Set the property corresponding toYangModel.getBody()to the specified value.UploadYangModelInputBuildersetName(String value)Set the property corresponding toYangModelNameVersion.getName()to the specified value.UploadYangModelInputBuildersetVersion(ModuleVersionType value)Set the property corresponding toYangModelNameVersion.getVersion()to the specified value.
-
-
-
Constructor Detail
-
UploadYangModelInputBuilder
public UploadYangModelInputBuilder()
Construct an empty builder.
-
UploadYangModelInputBuilder
public UploadYangModelInputBuilder(YangModel arg)
Construct a new builder initialized from specifiedYangModel.- Parameters:
arg- YangModel from which the builder should be initialized
-
UploadYangModelInputBuilder
public UploadYangModelInputBuilder(YangModelNameVersion arg)
Construct a new builder initialized from specifiedYangModelNameVersion.- Parameters:
arg- YangModelNameVersion from which the builder should be initialized
-
UploadYangModelInputBuilder
public UploadYangModelInputBuilder(UploadYangModelInput base)
Construct a builder initialized with state from specifiedUploadYangModelInput.- Parameters:
base- UploadYangModelInput from which the builder should be initialized
-
-
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:- Parameters:
arg- grouping object- Throws:
IllegalArgumentException- if given argument is none of valid types or has property with incompatible value
-
getBody
public String getBody()
Return current value associated with the property corresponding toYangModel.getBody().- Returns:
- current value
-
getName
public String getName()
Return current value associated with the property corresponding toYangModelNameVersion.getName().- Returns:
- current value
-
getVersion
public ModuleVersionType getVersion()
Return current value associated with the property corresponding toYangModelNameVersion.getVersion().- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UploadYangModelInput>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$- augmentation type- Parameters:
augmentationType- augmentation type class- Returns:
- Augmentation object from this builder, or
nullif not present - Throws:
NullPointerException- ifaugmentTypeisnull
-
setBody
public UploadYangModelInputBuilder setBody(String value)
Set the property corresponding toYangModel.getBody()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setName
public UploadYangModelInputBuilder setName(String value)
Set the property corresponding toYangModelNameVersion.getName()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setVersion
public UploadYangModelInputBuilder setVersion(ModuleVersionType value)
Set the property corresponding toYangModelNameVersion.getVersion()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
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- ifaugmentationis 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 @NonNull UploadYangModelInput build()
A newUploadYangModelInputinstance.- Returns:
- A new
UploadYangModelInputinstance.
-
-