Class MappingRecordItemBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping._record.list.MappingRecordItemBuilder
Class that builds
MappingRecordItem
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:
MappingRecordItem createMappingRecordItem(int fooXyzzy, int barBaz) {
return new MappingRecordItemBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of MappingRecordItem, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedMappingRecordItem
.Construct a new builder initialized from specifiedMappingRecordContainer
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<MappingRecordItem> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingRecordItem>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull MappingRecordItem
build()
A newMappingRecordItem
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toMappingRecordContainer.getMappingRecord()
.Return current value associated with the property corresponding toMappingRecordItem.getMappingRecordItemId()
.key()
Return current value associated with the property corresponding toMappingRecordItem.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingRecordItem>> augmentationType) Remove an augmentation from this builder's product.setMappingRecord
(MappingRecord value) Set the property corresponding toMappingRecordContainer.getMappingRecord()
to the specified value.setMappingRecordItemId
(String value) Set the property corresponding toMappingRecordItem.getMappingRecordItemId()
to the specified value.Set the key value corresponding toMappingRecordItem.key()
to the specified value.
-
Constructor Details
-
MappingRecordItemBuilder
public MappingRecordItemBuilder()Construct an empty builder. -
MappingRecordItemBuilder
Construct a new builder initialized from specifiedMappingRecordContainer
.- Parameters:
arg
- MappingRecordContainer from which the builder should be initialized
-
MappingRecordItemBuilder
Construct a builder initialized with state from specifiedMappingRecordItem
.- Parameters:
base
- MappingRecordItem from which the builder should be initialized
-
-
Method Details
-
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
-
key
Return current value associated with the property corresponding toMappingRecordItem.key()
.- Returns:
- current value
-
getMappingRecord
Return current value associated with the property corresponding toMappingRecordContainer.getMappingRecord()
.- Returns:
- current value
-
getMappingRecordItemId
Return current value associated with the property corresponding toMappingRecordItem.getMappingRecordItemId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingRecordItem>> 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
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
withKey
Set the key value corresponding toMappingRecordItem.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setMappingRecord
Set the property corresponding toMappingRecordContainer.getMappingRecord()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMappingRecordItemId
Set the property corresponding toMappingRecordItem.getMappingRecordItemId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MappingRecordItemBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MappingRecordItem> augmentation) Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public MappingRecordItemBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingRecordItem>> 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
A newMappingRecordItem
instance.- Returns:
- A new
MappingRecordItem
instance.
-