Class RequestMappingBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.RequestMappingBuilder
-
@Generated("mdsal-binding-generator") public class RequestMappingBuilder extends java.lang.Object
Class that buildsRequestMapping
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:
RequestMapping createRequestMapping(int fooXyzzy, int barBaz) { return new RequestMappingBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RequestMapping, 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:
RequestMapping
- 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 RequestMappingBuilder()
Construct an empty builder.RequestMappingBuilder(MapRequestNotification arg)
Construct a new builder initialized from specifiedMapRequestNotification
.RequestMappingBuilder(RequestMapping base)
Construct a builder initialized with state from specifiedRequestMapping
.RequestMappingBuilder(TransportAddress arg)
Construct a new builder initialized from specifiedTransportAddress
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RequestMappingBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RequestMapping> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RequestMapping>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull RequestMapping
build()
A newRequestMapping
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 toMapRequestNotification.getMapRequest()
.TransportAddress
getTransportAddress()
Return current value associated with the property corresponding toTransportAddress.getTransportAddress()
.RequestMappingBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RequestMapping>> augmentationType)
Remove an augmentation from this builder's product.RequestMappingBuilder
setMapRequest(MapRequest value)
Set the property corresponding toMapRequestNotification.getMapRequest()
to the specified value.RequestMappingBuilder
setTransportAddress(TransportAddress value)
Set the property corresponding toTransportAddress.getTransportAddress()
to the specified value.
-
-
-
Constructor Detail
-
RequestMappingBuilder
public RequestMappingBuilder()
Construct an empty builder.
-
RequestMappingBuilder
public RequestMappingBuilder(MapRequestNotification arg)
Construct a new builder initialized from specifiedMapRequestNotification
.- Parameters:
arg
- MapRequestNotification from which the builder should be initialized
-
RequestMappingBuilder
public RequestMappingBuilder(TransportAddress arg)
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
-
RequestMappingBuilder
public RequestMappingBuilder(RequestMapping base)
Construct a builder initialized with state from specifiedRequestMapping
.- Parameters:
base
- RequestMapping 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
-
getMapRequest
public MapRequest getMapRequest()
Return current value associated with the property corresponding toMapRequestNotification.getMapRequest()
.- Returns:
- current value
-
getTransportAddress
public TransportAddress getTransportAddress()
Return current value associated with the property corresponding toTransportAddress.getTransportAddress()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RequestMapping>> 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
-
setMapRequest
public RequestMappingBuilder setMapRequest(MapRequest value)
Set the property corresponding toMapRequestNotification.getMapRequest()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTransportAddress
public RequestMappingBuilder setTransportAddress(TransportAddress value)
Set the property corresponding toTransportAddress.getTransportAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public RequestMappingBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RequestMapping> 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 RequestMappingBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RequestMapping>> 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 RequestMapping build()
A newRequestMapping
instance.- Returns:
- A new
RequestMapping
instance.
-
-