Class MapRequestBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequestmessage.MapRequestBuilder
-
@Generated("mdsal-binding-generator") public class MapRequestBuilder extends java.lang.Object
Class that buildsMapRequest
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:
MapRequest createMapRequest(int fooXyzzy, int barBaz) { return new MapRequestBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MapRequest, 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:
MapRequest
- 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 MapRequestBuilder()
Construct an empty builder.MapRequestBuilder(EidList arg)
Construct a new builder initialized from specifiedEidList
.MapRequestBuilder(MapRequest arg)
Construct a new builder initialized from specifiedMapRequest
.MapRequestBuilder(MapRequest base)
Construct a builder initialized with state from specifiedMapRequest
.MapRequestBuilder(MapRequestMetadata arg)
Construct a new builder initialized from specifiedMapRequestMetadata
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MapRequestBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MapRequest> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRequest>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MapRequest
build()
A newMapRequest
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.java.lang.Boolean
getAuthoritative()
Return current value associated with the property corresponding toMapRequest.getAuthoritative()
.java.util.List<EidItem>
getEidItem()
Return current value associated with the property corresponding toEidList.getEidItem()
.java.util.List<ItrRloc>
getItrRloc()
Return current value associated with the property corresponding toMapRequest.getItrRloc()
.java.lang.Boolean
getMapDataPresent()
Return current value associated with the property corresponding toMapRequest.getMapDataPresent()
.MapReply
getMapReply()
Return current value associated with the property corresponding toMapRequest.getMapReply()
.java.lang.Long
getNonce()
Return current value associated with the property corresponding toMapRequest.getNonce()
.java.lang.Boolean
getPitr()
Return current value associated with the property corresponding toMapRequest.getPitr()
.java.lang.Boolean
getProbe()
Return current value associated with the property corresponding toMapRequest.getProbe()
.java.lang.Boolean
getSmr()
Return current value associated with the property corresponding toMapRequest.getSmr()
.java.lang.Boolean
getSmrInvoked()
Return current value associated with the property corresponding toMapRequest.getSmrInvoked()
.SourceEid
getSourceEid()
Return current value associated with the property corresponding toMapRequest.getSourceEid()
.IpAddressBinary
getSourceRloc()
Return current value associated with the property corresponding toMapRequestMetadata.getSourceRloc()
.MapRequestBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRequest>> augmentationType)
Remove an augmentation from this builder's product.MapRequestBuilder
setAuthoritative(java.lang.Boolean value)
Set the property corresponding toMapRequest.getAuthoritative()
to the specified value.MapRequestBuilder
setEidItem(java.util.List<EidItem> values)
Set the property corresponding toEidList.getEidItem()
to the specified value.MapRequestBuilder
setItrRloc(java.util.List<ItrRloc> values)
Set the property corresponding toMapRequest.getItrRloc()
to the specified value.MapRequestBuilder
setMapDataPresent(java.lang.Boolean value)
Set the property corresponding toMapRequest.getMapDataPresent()
to the specified value.MapRequestBuilder
setMapReply(MapReply value)
Set the property corresponding toMapRequest.getMapReply()
to the specified value.MapRequestBuilder
setNonce(java.lang.Long value)
Set the property corresponding toMapRequest.getNonce()
to the specified value.MapRequestBuilder
setPitr(java.lang.Boolean value)
Set the property corresponding toMapRequest.getPitr()
to the specified value.MapRequestBuilder
setProbe(java.lang.Boolean value)
Set the property corresponding toMapRequest.getProbe()
to the specified value.MapRequestBuilder
setSmr(java.lang.Boolean value)
Set the property corresponding toMapRequest.getSmr()
to the specified value.MapRequestBuilder
setSmrInvoked(java.lang.Boolean value)
Set the property corresponding toMapRequest.getSmrInvoked()
to the specified value.MapRequestBuilder
setSourceEid(SourceEid value)
Set the property corresponding toMapRequest.getSourceEid()
to the specified value.MapRequestBuilder
setSourceRloc(IpAddressBinary value)
Set the property corresponding toMapRequestMetadata.getSourceRloc()
to the specified value.
-
-
-
Constructor Detail
-
MapRequestBuilder
public MapRequestBuilder()
Construct an empty builder.
-
MapRequestBuilder
public MapRequestBuilder(MapRequest arg)
Construct a new builder initialized from specifiedMapRequest
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapRequest from which the builder should be initialized
-
MapRequestBuilder
public MapRequestBuilder(EidList arg)
Construct a new builder initialized from specifiedEidList
.- Parameters:
arg
- EidList from which the builder should be initialized
-
MapRequestBuilder
public MapRequestBuilder(MapRequestMetadata arg)
Construct a new builder initialized from specifiedMapRequestMetadata
.- Parameters:
arg
- MapRequestMetadata from which the builder should be initialized
-
MapRequestBuilder
public MapRequestBuilder(MapRequest base)
Construct a builder initialized with state from specifiedMapRequest
.- Parameters:
base
- MapRequest 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:
java.lang.IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAuthoritative
public java.lang.Boolean getAuthoritative()
Return current value associated with the property corresponding toMapRequest.getAuthoritative()
.- Returns:
- current value
-
getEidItem
public java.util.List<EidItem> getEidItem()
Return current value associated with the property corresponding toEidList.getEidItem()
.- Returns:
- current value
-
getItrRloc
public java.util.List<ItrRloc> getItrRloc()
Return current value associated with the property corresponding toMapRequest.getItrRloc()
.- Returns:
- current value
-
getMapDataPresent
public java.lang.Boolean getMapDataPresent()
Return current value associated with the property corresponding toMapRequest.getMapDataPresent()
.- Returns:
- current value
-
getMapReply
public MapReply getMapReply()
Return current value associated with the property corresponding toMapRequest.getMapReply()
.- Returns:
- current value
-
getNonce
public java.lang.Long getNonce()
Return current value associated with the property corresponding toMapRequest.getNonce()
.- Returns:
- current value
-
getPitr
public java.lang.Boolean getPitr()
Return current value associated with the property corresponding toMapRequest.getPitr()
.- Returns:
- current value
-
getProbe
public java.lang.Boolean getProbe()
Return current value associated with the property corresponding toMapRequest.getProbe()
.- Returns:
- current value
-
getSmr
public java.lang.Boolean getSmr()
Return current value associated with the property corresponding toMapRequest.getSmr()
.- Returns:
- current value
-
getSmrInvoked
public java.lang.Boolean getSmrInvoked()
Return current value associated with the property corresponding toMapRequest.getSmrInvoked()
.- Returns:
- current value
-
getSourceEid
public SourceEid getSourceEid()
Return current value associated with the property corresponding toMapRequest.getSourceEid()
.- Returns:
- current value
-
getSourceRloc
public IpAddressBinary getSourceRloc()
Return current value associated with the property corresponding toMapRequestMetadata.getSourceRloc()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRequest>> E$$ augmentation(java.lang.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:
java.lang.NullPointerException
- ifaugmentType
isnull
-
setAuthoritative
public MapRequestBuilder setAuthoritative(java.lang.Boolean value)
Set the property corresponding toMapRequest.getAuthoritative()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEidItem
public MapRequestBuilder setEidItem(java.util.List<EidItem> values)
Set the property corresponding toEidList.getEidItem()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setItrRloc
public MapRequestBuilder setItrRloc(java.util.List<ItrRloc> values)
Set the property corresponding toMapRequest.getItrRloc()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setMapDataPresent
public MapRequestBuilder setMapDataPresent(java.lang.Boolean value)
Set the property corresponding toMapRequest.getMapDataPresent()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMapReply
public MapRequestBuilder setMapReply(MapReply value)
Set the property corresponding toMapRequest.getMapReply()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNonce
public MapRequestBuilder setNonce(java.lang.Long value)
Set the property corresponding toMapRequest.getNonce()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPitr
public MapRequestBuilder setPitr(java.lang.Boolean value)
Set the property corresponding toMapRequest.getPitr()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProbe
public MapRequestBuilder setProbe(java.lang.Boolean value)
Set the property corresponding toMapRequest.getProbe()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSmr
public MapRequestBuilder setSmr(java.lang.Boolean value)
Set the property corresponding toMapRequest.getSmr()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSmrInvoked
public MapRequestBuilder setSmrInvoked(java.lang.Boolean value)
Set the property corresponding toMapRequest.getSmrInvoked()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSourceEid
public MapRequestBuilder setSourceEid(SourceEid value)
Set the property corresponding toMapRequest.getSourceEid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSourceRloc
public MapRequestBuilder setSourceRloc(IpAddressBinary value)
Set the property corresponding toMapRequestMetadata.getSourceRloc()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MapRequestBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MapRequest> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public MapRequestBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRequest>> 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 MapRequest build()
A newMapRequest
instance.- Returns:
- A new
MapRequest
instance.
-
-