Class RouteMonitoringMessageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.RouteMonitoringMessageBuilder
-
@Generated("mdsal-binding-generator") public class RouteMonitoringMessageBuilder extends Object
Class that buildsRouteMonitoringMessage
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:
RouteMonitoringMessage createRouteMonitoringMessage(int fooXyzzy, int barBaz) { return new RouteMonitoringMessageBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RouteMonitoringMessage, 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:
RouteMonitoringMessage
- 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 RouteMonitoringMessageBuilder()
Construct an empty builder.RouteMonitoringMessageBuilder(PeerHeader arg)
Construct a new builder initialized from specifiedPeerHeader
.RouteMonitoringMessageBuilder(RouteMonitoringMessage base)
Construct a builder initialized with state from specifiedRouteMonitoringMessage
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RouteMonitoringMessageBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RouteMonitoringMessage> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteMonitoringMessage>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull RouteMonitoringMessage
build()
A newRouteMonitoringMessage
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.PeerHeader
getPeerHeader()
Return current value associated with the property corresponding toPeerHeader.getPeerHeader()
.Update
getUpdate()
Return current value associated with the property corresponding toRouteMonitoringMessage.getUpdate()
.RouteMonitoringMessageBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteMonitoringMessage>> augmentationType)
Remove an augmentation from this builder's product.RouteMonitoringMessageBuilder
setPeerHeader(PeerHeader value)
Set the property corresponding toPeerHeader.getPeerHeader()
to the specified value.RouteMonitoringMessageBuilder
setUpdate(Update value)
Set the property corresponding toRouteMonitoringMessage.getUpdate()
to the specified value.
-
-
-
Constructor Detail
-
RouteMonitoringMessageBuilder
public RouteMonitoringMessageBuilder()
Construct an empty builder.
-
RouteMonitoringMessageBuilder
public RouteMonitoringMessageBuilder(PeerHeader arg)
Construct a new builder initialized from specifiedPeerHeader
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.PeerHeader from which the builder should be initialized
-
RouteMonitoringMessageBuilder
public RouteMonitoringMessageBuilder(RouteMonitoringMessage base)
Construct a builder initialized with state from specifiedRouteMonitoringMessage
.- Parameters:
base
- RouteMonitoringMessage 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:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getPeerHeader
public PeerHeader getPeerHeader()
Return current value associated with the property corresponding toPeerHeader.getPeerHeader()
.- Returns:
- current value
-
getUpdate
public Update getUpdate()
Return current value associated with the property corresponding toRouteMonitoringMessage.getUpdate()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteMonitoringMessage>> 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
-
setPeerHeader
public RouteMonitoringMessageBuilder setPeerHeader(PeerHeader value)
Set the property corresponding toPeerHeader.getPeerHeader()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setUpdate
public RouteMonitoringMessageBuilder setUpdate(Update value)
Set the property corresponding toRouteMonitoringMessage.getUpdate()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public RouteMonitoringMessageBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RouteMonitoringMessage> 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 RouteMonitoringMessageBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteMonitoringMessage>> 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 RouteMonitoringMessage build()
A newRouteMonitoringMessage
instance.- Returns:
- A new
RouteMonitoringMessage
instance.
-
-