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