Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120

Class RouteMonitoringMessageBuilder

java.lang.Object

org.opendaylight.yangtools.binding.lib.AugmentableBuilder<RouteMonitoringMessage,RouteMonitoringMessageBuilder>

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.RouteMonitoringMessageBuilder

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Mutable

@Generated("mdsal-binding-generator")
public class RouteMonitoringMessageBuilder
extends org.opendaylight.yangtools.binding.lib.AugmentableBuilder<RouteMonitoringMessage,RouteMonitoringMessageBuilder>

Class that builds RouteMonitoringMessage 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

Constructor Summary

Constructors

Constructor	Description
RouteMonitoringMessageBuilder()	Construct an empty builder.
RouteMonitoringMessageBuilder(PeerHeader arg)	Construct a new builder initialized from specified PeerHeader.
RouteMonitoringMessageBuilder(RouteMonitoringMessage base)	Construct a builder initialized with state from specified RouteMonitoringMessage.

Method Summary

Modifier and Type	Method	Description
@NonNull RouteMonitoringMessage	build()	Returns A new RouteMonitoringMessage instance.
void	fieldsFrom(org.opendaylight.yangtools.binding.Grouping arg)	Set fields from given grouping argument.
PeerHeader	getPeerHeader()	Deprecated, for removal: This API element is subject to removal in a future version. This method will not be generated in a future release
Update	getUpdate()	Deprecated, for removal: This API element is subject to removal in a future version. This method will not be generated in a future release
RouteMonitoringMessageBuilder	setPeerHeader(PeerHeader value)	Set the property corresponding to PeerHeader.getPeerHeader() to the specified value.
RouteMonitoringMessageBuilder	setUpdate(Update value)	Set the property corresponding to RouteMonitoringMessage.getUpdate() to the specified value.

Methods inherited from class org.opendaylight.yangtools.binding.lib.AugmentableBuilder

addAugmentation, augmentation, augmentations, removeAugmentation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RouteMonitoringMessageBuilder

public RouteMonitoringMessageBuilder()

Construct an empty builder.

RouteMonitoringMessageBuilder

public RouteMonitoringMessageBuilder(PeerHeader arg)

Construct a new builder initialized from specified PeerHeader.

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 specified RouteMonitoringMessage.

Parameters:

base - RouteMonitoringMessage from which the builder should be initialized

Method Details

fieldsFrom

public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping arg)

Set fields from given grouping argument. Valid argument is instance of one of following types:

• PeerHeader

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

getPeerHeader

@Deprecated(forRemoval=true)
public PeerHeader getPeerHeader()

Deprecated, for removal: This API element is subject to removal in a future version.

This method will not be generated in a future release

Return current value associated with the property corresponding to PeerHeader.getPeerHeader().

Returns:

current value

getUpdate

@Deprecated(forRemoval=true)
public Update getUpdate()

Deprecated, for removal: This API element is subject to removal in a future version.

This method will not be generated in a future release

Return current value associated with the property corresponding to RouteMonitoringMessage.getUpdate().

Returns:

current value

setPeerHeader

public RouteMonitoringMessageBuilder setPeerHeader(PeerHeader value)

Set the property corresponding to PeerHeader.getPeerHeader() to the specified value.

Parameters:

value - desired value

Returns:

this builder

setUpdate

public RouteMonitoringMessageBuilder setUpdate(Update value)

Set the property corresponding to RouteMonitoringMessage.getUpdate() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull RouteMonitoringMessage build()

Returns A new RouteMonitoringMessage instance.

Returns:

A new RouteMonitoringMessage instance