Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.mapping.authkey.list
Class MappingAuthkeyItemBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.mapping.authkey.list.MappingAuthkeyItemBuilder
-
@Generated("mdsal-binding-generator") public class MappingAuthkeyItemBuilder extends java.lang.Object
Class that buildsMappingAuthkeyItem
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:
MappingAuthkeyItem createMappingAuthkeyItem(int fooXyzzy, int barBaz) { return new MappingAuthkeyItemBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MappingAuthkeyItem, 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:
MappingAuthkeyItem
- 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 MappingAuthkeyItemBuilder()
Construct an empty builder.MappingAuthkeyItemBuilder(MappingAuthkeyContainer arg)
Construct a new builder initialized from specifiedMappingAuthkeyContainer
.MappingAuthkeyItemBuilder(MappingAuthkeyItem base)
Construct a builder initialized with state from specifiedMappingAuthkeyItem
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MappingAuthkeyItemBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MappingAuthkeyItem> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingAuthkeyItem>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MappingAuthkeyItem
build()
A newMappingAuthkeyItem
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MappingAuthkey
getMappingAuthkey()
Return current value associated with the property corresponding toMappingAuthkeyContainer.getMappingAuthkey()
.java.lang.String
getMappingAuthkeyItemId()
Return current value associated with the property corresponding toMappingAuthkeyItem.getMappingAuthkeyItemId()
.MappingAuthkeyItemKey
key()
Return current value associated with the property corresponding toMappingAuthkeyItem.key()
.MappingAuthkeyItemBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingAuthkeyItem>> augmentationType)
Remove an augmentation from this builder's product.MappingAuthkeyItemBuilder
setMappingAuthkey(MappingAuthkey value)
Set the property corresponding toMappingAuthkeyContainer.getMappingAuthkey()
to the specified value.MappingAuthkeyItemBuilder
setMappingAuthkeyItemId(java.lang.String value)
Set the property corresponding toMappingAuthkeyItem.getMappingAuthkeyItemId()
to the specified value.MappingAuthkeyItemBuilder
withKey(MappingAuthkeyItemKey key)
-
-
-
Constructor Detail
-
MappingAuthkeyItemBuilder
public MappingAuthkeyItemBuilder()
Construct an empty builder.
-
MappingAuthkeyItemBuilder
public MappingAuthkeyItemBuilder(MappingAuthkeyContainer arg)
Construct a new builder initialized from specifiedMappingAuthkeyContainer
.- Parameters:
arg
- MappingAuthkeyContainer from which the builder should be initialized
-
MappingAuthkeyItemBuilder
public MappingAuthkeyItemBuilder(MappingAuthkeyItem base)
Construct a builder initialized with state from specifiedMappingAuthkeyItem
.- Parameters:
base
- MappingAuthkeyItem 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
-
key
public MappingAuthkeyItemKey key()
Return current value associated with the property corresponding toMappingAuthkeyItem.key()
.- Returns:
- current value
-
getMappingAuthkey
public MappingAuthkey getMappingAuthkey()
Return current value associated with the property corresponding toMappingAuthkeyContainer.getMappingAuthkey()
.- Returns:
- current value
-
getMappingAuthkeyItemId
public java.lang.String getMappingAuthkeyItemId()
Return current value associated with the property corresponding toMappingAuthkeyItem.getMappingAuthkeyItemId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingAuthkeyItem>> 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
-
withKey
public MappingAuthkeyItemBuilder withKey(MappingAuthkeyItemKey key)
-
setMappingAuthkey
public MappingAuthkeyItemBuilder setMappingAuthkey(MappingAuthkey value)
Set the property corresponding toMappingAuthkeyContainer.getMappingAuthkey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMappingAuthkeyItemId
public MappingAuthkeyItemBuilder setMappingAuthkeyItemId(java.lang.String value)
Set the property corresponding toMappingAuthkeyItem.getMappingAuthkeyItemId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MappingAuthkeyItemBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MappingAuthkeyItem> 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 MappingAuthkeyItemBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingAuthkeyItem>> 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 MappingAuthkeyItem build()
A newMappingAuthkeyItem
instance.- Returns:
- A new
MappingAuthkeyItem
instance.
-
-