Class UpdateKeysInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.UpdateKeysInputBuilder
-
@Generated("mdsal-binding-generator") public class UpdateKeysInputBuilder extends java.lang.Object
Class that buildsUpdateKeysInput
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:
UpdateKeysInput createUpdateKeysInput(int fooXyzzy, int barBaz) { return new UpdateKeysInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of UpdateKeysInput, 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:
UpdateKeysInput
- 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 UpdateKeysInputBuilder()
Construct an empty builder.UpdateKeysInputBuilder(EidAuthkeyList arg)
Construct a new builder initialized from specifiedEidAuthkeyList
.UpdateKeysInputBuilder(UpdateKeysInput base)
Construct a builder initialized with state from specifiedUpdateKeysInput
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UpdateKeysInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateKeysInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateKeysInput>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull UpdateKeysInput
build()
A newUpdateKeysInput
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.java.util.Map<EidAuthkeyItemKey,EidAuthkeyItem>
getEidAuthkeyItem()
Return current value associated with the property corresponding toEidAuthkeyList.getEidAuthkeyItem()
.UpdateKeysInputBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateKeysInput>> augmentationType)
Remove an augmentation from this builder's product.UpdateKeysInputBuilder
setEidAuthkeyItem(java.util.Map<EidAuthkeyItemKey,EidAuthkeyItem> values)
Set the property corresponding toEidAuthkeyList.getEidAuthkeyItem()
to the specified value.
-
-
-
Constructor Detail
-
UpdateKeysInputBuilder
public UpdateKeysInputBuilder()
Construct an empty builder.
-
UpdateKeysInputBuilder
public UpdateKeysInputBuilder(EidAuthkeyList arg)
Construct a new builder initialized from specifiedEidAuthkeyList
.- Parameters:
arg
- EidAuthkeyList from which the builder should be initialized
-
UpdateKeysInputBuilder
public UpdateKeysInputBuilder(UpdateKeysInput base)
Construct a builder initialized with state from specifiedUpdateKeysInput
.- Parameters:
base
- UpdateKeysInput 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:
java.lang.IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getEidAuthkeyItem
public java.util.Map<EidAuthkeyItemKey,EidAuthkeyItem> getEidAuthkeyItem()
Return current value associated with the property corresponding toEidAuthkeyList.getEidAuthkeyItem()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateKeysInput>> E$$ augmentation(java.lang.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
null
if not present - Throws:
java.lang.NullPointerException
- ifaugmentType
isnull
-
setEidAuthkeyItem
public UpdateKeysInputBuilder setEidAuthkeyItem(java.util.Map<EidAuthkeyItemKey,EidAuthkeyItem> values)
Set the property corresponding toEidAuthkeyList.getEidAuthkeyItem()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public UpdateKeysInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateKeysInput> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public UpdateKeysInputBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateKeysInput>> 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 UpdateKeysInput build()
A newUpdateKeysInput
instance.- Returns:
- A new
UpdateKeysInput
instance.
-
-