Class RouteRefreshRequestInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.peer.rpc.rev180329.RouteRefreshRequestInputBuilder
-
@Generated("mdsal-binding-generator") public class RouteRefreshRequestInputBuilder extends Object
Class that buildsRouteRefreshRequestInput
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:
RouteRefreshRequestInput createRouteRefreshRequestInput(int fooXyzzy, int barBaz) { return new RouteRefreshRequestInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RouteRefreshRequestInput, 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:
RouteRefreshRequestInput
- 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 RouteRefreshRequestInputBuilder()
Construct an empty builder.RouteRefreshRequestInputBuilder(BgpTableType arg)
Construct a new builder initialized from specifiedBgpTableType
.RouteRefreshRequestInputBuilder(PeerReference arg)
Construct a new builder initialized from specifiedPeerReference
.RouteRefreshRequestInputBuilder(RouteRefreshRequestInput base)
Construct a builder initialized with state from specifiedRouteRefreshRequestInput
.RouteRefreshRequestInputBuilder(RrMsgArgs arg)
Construct a new builder initialized from specifiedRrMsgArgs
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RouteRefreshRequestInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RouteRefreshRequestInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteRefreshRequestInput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull RouteRefreshRequestInput
build()
A newRouteRefreshRequestInput
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Class<? extends AddressFamily>
getAfi()
Return current value associated with the property corresponding toBgpTableType.getAfi()
.PeerRef
getPeerRef()
Return current value associated with the property corresponding toPeerReference.getPeerRef()
.Class<? extends SubsequentAddressFamily>
getSafi()
Return current value associated with the property corresponding toBgpTableType.getSafi()
.RouteRefreshRequestInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteRefreshRequestInput>> augmentationType)
Remove an augmentation from this builder's product.RouteRefreshRequestInputBuilder
setAfi(Class<? extends AddressFamily> value)
Set the property corresponding toBgpTableType.getAfi()
to the specified value.RouteRefreshRequestInputBuilder
setPeerRef(PeerRef value)
Set the property corresponding toPeerReference.getPeerRef()
to the specified value.RouteRefreshRequestInputBuilder
setSafi(Class<? extends SubsequentAddressFamily> value)
Set the property corresponding toBgpTableType.getSafi()
to the specified value.
-
-
-
Constructor Detail
-
RouteRefreshRequestInputBuilder
public RouteRefreshRequestInputBuilder()
Construct an empty builder.
-
RouteRefreshRequestInputBuilder
public RouteRefreshRequestInputBuilder(RrMsgArgs arg)
Construct a new builder initialized from specifiedRrMsgArgs
.- Parameters:
arg
- RrMsgArgs from which the builder should be initialized
-
RouteRefreshRequestInputBuilder
public RouteRefreshRequestInputBuilder(PeerReference arg)
Construct a new builder initialized from specifiedPeerReference
.- Parameters:
arg
- PeerReference from which the builder should be initialized
-
RouteRefreshRequestInputBuilder
public RouteRefreshRequestInputBuilder(BgpTableType arg)
Construct a new builder initialized from specifiedBgpTableType
.- Parameters:
arg
- BgpTableType from which the builder should be initialized
-
RouteRefreshRequestInputBuilder
public RouteRefreshRequestInputBuilder(RouteRefreshRequestInput base)
Construct a builder initialized with state from specifiedRouteRefreshRequestInput
.- Parameters:
base
- RouteRefreshRequestInput 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
-
getAfi
public Class<? extends AddressFamily> getAfi()
Return current value associated with the property corresponding toBgpTableType.getAfi()
.- Returns:
- current value
-
getPeerRef
public PeerRef getPeerRef()
Return current value associated with the property corresponding toPeerReference.getPeerRef()
.- Returns:
- current value
-
getSafi
public Class<? extends SubsequentAddressFamily> getSafi()
Return current value associated with the property corresponding toBgpTableType.getSafi()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteRefreshRequestInput>> 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
-
setAfi
public RouteRefreshRequestInputBuilder setAfi(Class<? extends AddressFamily> value)
Set the property corresponding toBgpTableType.getAfi()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPeerRef
public RouteRefreshRequestInputBuilder setPeerRef(PeerRef value)
Set the property corresponding toPeerReference.getPeerRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSafi
public RouteRefreshRequestInputBuilder setSafi(Class<? extends SubsequentAddressFamily> value)
Set the property corresponding toBgpTableType.getSafi()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public RouteRefreshRequestInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RouteRefreshRequestInput> 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 RouteRefreshRequestInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteRefreshRequestInput>> 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 RouteRefreshRequestInput build()
A newRouteRefreshRequestInput
instance.- Returns:
- A new
RouteRefreshRequestInput
instance.
-
-