Class GotMapNotifyBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.GotMapNotifyBuilder
Class that builds
GotMapNotify
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:
GotMapNotify createGotMapNotify(int fooXyzzy, int barBaz) {
return new GotMapNotifyBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of GotMapNotify, 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 specifiedGotMapNotify
.Construct a new builder initialized from specifiedMapNotifyNotification
.Construct a new builder initialized from specifiedTransportAddress
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<GotMapNotify> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GotMapNotify>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull GotMapNotify
build()
A newGotMapNotify
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toMapNotifyNotification.getMapNotify()
.Return current value associated with the property corresponding toTransportAddress.getTransportAddress()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GotMapNotify>> augmentationType) Remove an augmentation from this builder's product.setMapNotify
(MapNotify value) Set the property corresponding toMapNotifyNotification.getMapNotify()
to the specified value.Set the property corresponding toTransportAddress.getTransportAddress()
to the specified value.
-
Constructor Details
-
GotMapNotifyBuilder
public GotMapNotifyBuilder()Construct an empty builder. -
GotMapNotifyBuilder
Construct a new builder initialized from specifiedMapNotifyNotification
.- Parameters:
arg
- MapNotifyNotification from which the builder should be initialized
-
GotMapNotifyBuilder
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
-
GotMapNotifyBuilder
Construct a builder initialized with state from specifiedGotMapNotify
.- Parameters:
base
- GotMapNotify 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
-
getMapNotify
Return current value associated with the property corresponding toMapNotifyNotification.getMapNotify()
.- Returns:
- current value
-
getTransportAddress
Return current value associated with the property corresponding toTransportAddress.getTransportAddress()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GotMapNotify>> 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
-
setMapNotify
Set the property corresponding toMapNotifyNotification.getMapNotify()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTransportAddress
Set the property corresponding toTransportAddress.getTransportAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public GotMapNotifyBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GotMapNotify> 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 GotMapNotifyBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GotMapNotify>> 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 newGotMapNotify
instance.- Returns:
- A new
GotMapNotify
instance.
-