Class MappingRecordItemBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.list.MappingRecordItemBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MappingRecordItem>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MappingRecordItem,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MappingRecordItemBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<MappingRecordItem>
Class that buildsMappingRecordItemBuilder
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:
MappingRecordItemBuilder createTarget(int fooXyzzy, int barBaz) { return new MappingRecordItemBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MappingRecordItemBuilder, 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 oportunities, 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:
MappingRecordItemBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MappingRecordItemBuilder()
MappingRecordItemBuilder(MappingRecordItem base)
MappingRecordItemBuilder(MappingRecordContainer arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MappingRecordItemBuilder
addAugmentation(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(java.lang.Class<E$$> augmentationType)
MappingRecordItem
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MappingRecord
getMappingRecord()
java.lang.String
getMappingRecordItemId()
MappingRecordItemKey
key()
MappingRecordItemBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingRecordItem>> augmentationType)
Remove an augmentation from this builder's product.MappingRecordItemBuilder
setMappingRecord(MappingRecord value)
MappingRecordItemBuilder
setMappingRecordItemId(java.lang.String value)
MappingRecordItemBuilder
withKey(MappingRecordItemKey key)
-
-
-
Constructor Detail
-
MappingRecordItemBuilder
public MappingRecordItemBuilder()
-
MappingRecordItemBuilder
public MappingRecordItemBuilder(MappingRecordContainer arg)
-
MappingRecordItemBuilder
public MappingRecordItemBuilder(MappingRecordItem base)
-
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MappingRecordContainer
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public MappingRecordItemKey key()
-
getMappingRecord
public MappingRecord getMappingRecord()
-
getMappingRecordItemId
public java.lang.String getMappingRecordItemId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingRecordItem>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public MappingRecordItemBuilder withKey(MappingRecordItemKey key)
-
setMappingRecord
public MappingRecordItemBuilder setMappingRecord(MappingRecord value)
-
setMappingRecordItemId
public MappingRecordItemBuilder setMappingRecordItemId(java.lang.String value)
-
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:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public MappingRecordItemBuilder removeAugmentation(java.lang.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
public MappingRecordItem build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MappingRecordItem>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MappingRecordItem,java.lang.IllegalArgumentException>
-
-