Class AddMappingBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.AddMappingBuilder
-
@Generated("mdsal-binding-generator") public class AddMappingBuilder extends java.lang.Object
Class that buildsAddMapping
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:
AddMapping createAddMapping(int fooXyzzy, int barBaz) { return new AddMappingBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AddMapping, 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:
AddMapping
- 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 AddMappingBuilder()
Construct an empty builder.AddMappingBuilder(AddMapping base)
Construct a builder initialized with state from specifiedAddMapping
.AddMappingBuilder(MapRegisterNotification arg)
Construct a new builder initialized from specifiedMapRegisterNotification
.AddMappingBuilder(TransportAddress arg)
Construct a new builder initialized from specifiedTransportAddress
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AddMappingBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AddMapping> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AddMapping>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull AddMapping
build()
A newAddMapping
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MapRegister
getMapRegister()
Return current value associated with the property corresponding toMapRegisterNotification.getMapRegister()
.TransportAddress
getTransportAddress()
Return current value associated with the property corresponding toTransportAddress.getTransportAddress()
.AddMappingBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddMapping>> augmentationType)
Remove an augmentation from this builder's product.AddMappingBuilder
setMapRegister(MapRegister value)
Set the property corresponding toMapRegisterNotification.getMapRegister()
to the specified value.AddMappingBuilder
setTransportAddress(TransportAddress value)
Set the property corresponding toTransportAddress.getTransportAddress()
to the specified value.
-
-
-
Constructor Detail
-
AddMappingBuilder
public AddMappingBuilder()
Construct an empty builder.
-
AddMappingBuilder
public AddMappingBuilder(MapRegisterNotification arg)
Construct a new builder initialized from specifiedMapRegisterNotification
.- Parameters:
arg
- MapRegisterNotification from which the builder should be initialized
-
AddMappingBuilder
public AddMappingBuilder(TransportAddress arg)
Construct a new builder initialized from specifiedTransportAddress
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.TransportAddress from which the builder should be initialized
-
AddMappingBuilder
public AddMappingBuilder(AddMapping base)
Construct a builder initialized with state from specifiedAddMapping
.- Parameters:
base
- AddMapping 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
-
getMapRegister
public MapRegister getMapRegister()
Return current value associated with the property corresponding toMapRegisterNotification.getMapRegister()
.- Returns:
- current value
-
getTransportAddress
public TransportAddress getTransportAddress()
Return current value associated with the property corresponding toTransportAddress.getTransportAddress()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AddMapping>> 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
-
setMapRegister
public AddMappingBuilder setMapRegister(MapRegister value)
Set the property corresponding toMapRegisterNotification.getMapRegister()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTransportAddress
public AddMappingBuilder setTransportAddress(TransportAddress value)
Set the property corresponding toTransportAddress.getTransportAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public AddMappingBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AddMapping> 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 AddMappingBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddMapping>> 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 AddMapping build()
A newAddMapping
instance.- Returns:
- A new
AddMapping
instance.
-
-