Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105

Class XtrRequestMappingBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.XtrRequestMappingBuilder

@Generated("mdsal-binding-generator")
public class XtrRequestMappingBuilder
extends Object

Class that builds XtrRequestMapping 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:

   
     XtrRequestMapping createXtrRequestMapping(int fooXyzzy, int barBaz) {
         return new XtrRequestMappingBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

This pattern is supported by the immutable nature of XtrRequestMapping, 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:

• XtrRequestMapping

Constructor Summary

Constructors

Constructor	Description
XtrRequestMappingBuilder()	Construct an empty builder.
XtrRequestMappingBuilder(MapRequestNotification arg)	Construct a new builder initialized from specified MapRequestNotification.
XtrRequestMappingBuilder(TransportAddress arg)	Construct a new builder initialized from specified TransportAddress.
XtrRequestMappingBuilder(XtrRequestMapping base)	Construct a builder initialized with state from specified XtrRequestMapping.

Method Summary

Modifier and Type	Method	Description
XtrRequestMappingBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<XtrRequestMapping> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<XtrRequestMapping>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull XtrRequestMapping	build()	A new XtrRequestMapping instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
MapRequest	getMapRequest()	Return current value associated with the property corresponding to MapRequestNotification.getMapRequest().
TransportAddress	getTransportAddress()	Return current value associated with the property corresponding to TransportAddress.getTransportAddress().
XtrRequestMappingBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<XtrRequestMapping>> augmentationType)	Remove an augmentation from this builder's product.
XtrRequestMappingBuilder	setMapRequest(MapRequest value)	Set the property corresponding to MapRequestNotification.getMapRequest() to the specified value.
XtrRequestMappingBuilder	setTransportAddress(TransportAddress value)	Set the property corresponding to TransportAddress.getTransportAddress() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

XtrRequestMappingBuilder

public XtrRequestMappingBuilder()

Construct an empty builder.

XtrRequestMappingBuilder

public XtrRequestMappingBuilder(MapRequestNotification arg)

Construct a new builder initialized from specified MapRequestNotification.

Parameters:

arg - MapRequestNotification from which the builder should be initialized

XtrRequestMappingBuilder

public XtrRequestMappingBuilder(TransportAddress arg)

Construct a new builder initialized from specified TransportAddress.

Parameters:

arg - org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.TransportAddress from which the builder should be initialized

XtrRequestMappingBuilder

public XtrRequestMappingBuilder(XtrRequestMapping base)

Construct a builder initialized with state from specified XtrRequestMapping.

Parameters:

base - XtrRequestMapping 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:

• MapRequestNotification
• TransportAddress

Parameters:

arg - grouping object

Throws:

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

getMapRequest

public MapRequest getMapRequest()

Return current value associated with the property corresponding to MapRequestNotification.getMapRequest().

Returns:

current value

getTransportAddress

public TransportAddress getTransportAddress()

Return current value associated with the property corresponding to TransportAddress.getTransportAddress().

Returns:

current value

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<XtrRequestMapping>>
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 - if augmentType is null

setMapRequest

public XtrRequestMappingBuilder setMapRequest(MapRequest value)

Set the property corresponding to MapRequestNotification.getMapRequest() to the specified value.

Parameters:

value - desired value

Returns:

this builder

setTransportAddress

public XtrRequestMappingBuilder setTransportAddress(TransportAddress value)

Set the property corresponding to TransportAddress.getTransportAddress() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

public XtrRequestMappingBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<XtrRequestMapping> augmentation)

Add an augmentation to this builder's product.

Parameters:

augmentation - augmentation to be added

Returns:

this builder

Throws:

NullPointerException - if augmentation is null

removeAugmentation

public XtrRequestMappingBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<XtrRequestMapping>> 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 XtrRequestMapping build()

A new XtrRequestMapping instance.

Returns:

A new XtrRequestMapping instance.