Class SendMapRegisterInputBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapRegisterInputBuilder
Class that builds
SendMapRegisterInput
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:
SendMapRegisterInput createSendMapRegisterInput(int fooXyzzy, int barBaz) {
return new SendMapRegisterInputBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of SendMapRegisterInput, 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.SendMapRegisterInputBuilder
(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapRegisterMessage arg) Construct a new builder initialized from specifiedMapRegisterMessage
.SendMapRegisterInputBuilder
(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.TransportAddress arg) Construct a new builder initialized from specifiedTransportAddress
.Construct a builder initialized with state from specifiedSendMapRegisterInput
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<SendMapRegisterInput> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SendMapRegisterInput>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull SendMapRegisterInput
build()
A newSendMapRegisterInput
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.mapregistermessage.MapRegister
Return current value associated with the property corresponding toMapRegisterMessage.getMapRegister()
.org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddress
Return current value associated with the property corresponding toTransportAddress.getTransportAddress()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SendMapRegisterInput>> augmentationType) Remove an augmentation from this builder's product.setMapRegister
(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapregistermessage.MapRegister value) Set the property corresponding toMapRegisterMessage.getMapRegister()
to the specified value.setTransportAddress
(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddress value) Set the property corresponding toTransportAddress.getTransportAddress()
to the specified value.
-
Constructor Details
-
SendMapRegisterInputBuilder
public SendMapRegisterInputBuilder()Construct an empty builder. -
SendMapRegisterInputBuilder
public SendMapRegisterInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapRegisterMessage arg) Construct a new builder initialized from specifiedMapRegisterMessage
.- Parameters:
arg
- MapRegisterMessage from which the builder should be initialized
-
SendMapRegisterInputBuilder
public SendMapRegisterInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.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
-
SendMapRegisterInputBuilder
Construct a builder initialized with state from specifiedSendMapRegisterInput
.- Parameters:
base
- SendMapRegisterInput 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:MapRegisterMessage
TransportAddress
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getMapRegister
public org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapregistermessage.MapRegister getMapRegister()Return current value associated with the property corresponding toMapRegisterMessage.getMapRegister()
.- Returns:
- current value
-
getTransportAddress
public org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.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<SendMapRegisterInput>> 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
-
setMapRegister
public SendMapRegisterInputBuilder setMapRegister(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapregistermessage.MapRegister value) Set the property corresponding toMapRegisterMessage.getMapRegister()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTransportAddress
public SendMapRegisterInputBuilder setTransportAddress(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddress value) Set the property corresponding toTransportAddress.getTransportAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SendMapRegisterInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SendMapRegisterInput> 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 SendMapRegisterInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SendMapRegisterInput>> 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 newSendMapRegisterInput
instance.- Returns:
- A new
SendMapRegisterInput
instance.
-