Class UpdateMappingInputBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.UpdateMappingInputBuilder
Class that builds
UpdateMappingInput
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:
UpdateMappingInput createUpdateMappingInput(int fooXyzzy, int barBaz) {
return new UpdateMappingInputBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of UpdateMappingInput, 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.UpdateMappingInputBuilder
(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MappingRecordContainer arg) Construct a new builder initialized from specifiedMappingRecordContainer
.Construct a builder initialized with state from specifiedUpdateMappingInput
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateMappingInput> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateMappingInput>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull UpdateMappingInput
build()
A newUpdateMappingInput
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping._record.container.MappingRecord
Return current value associated with the property corresponding toMappingRecordContainer.getMappingRecord()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateMappingInput>> augmentationType) Remove an augmentation from this builder's product.setMappingRecord
(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping._record.container.MappingRecord value) Set the property corresponding toMappingRecordContainer.getMappingRecord()
to the specified value.
-
Constructor Details
-
UpdateMappingInputBuilder
public UpdateMappingInputBuilder()Construct an empty builder. -
UpdateMappingInputBuilder
public UpdateMappingInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MappingRecordContainer arg) Construct a new builder initialized from specifiedMappingRecordContainer
.- Parameters:
arg
- MappingRecordContainer from which the builder should be initialized
-
UpdateMappingInputBuilder
Construct a builder initialized with state from specifiedUpdateMappingInput
.- Parameters:
base
- UpdateMappingInput 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:MappingRecordContainer
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getMappingRecord
public org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping._record.container.MappingRecord getMappingRecord()Return current value associated with the property corresponding toMappingRecordContainer.getMappingRecord()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateMappingInput>> 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
-
setMappingRecord
public UpdateMappingInputBuilder setMappingRecord(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping._record.container.MappingRecord value) Set the property corresponding toMappingRecordContainer.getMappingRecord()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public UpdateMappingInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateMappingInput> 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 UpdateMappingInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateMappingInput>> 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 newUpdateMappingInput
instance.- Returns:
- A new
UpdateMappingInput
instance.
-