Class SPmsiADBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.s.pmsi.a.d.grouping.SPmsiADBuilder
-
@Generated("mdsal-binding-generator") public class SPmsiADBuilder extends Object
Class that buildsSPmsiAD
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:
SPmsiAD createSPmsiAD(int fooXyzzy, int barBaz) { return new SPmsiADBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SPmsiAD, 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:
SPmsiAD
- 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 SPmsiADBuilder()
Construct an empty builder.SPmsiADBuilder(MulticastGroupOpaqueGrouping arg)
Construct a new builder initialized from specifiedMulticastGroupOpaqueGrouping
.SPmsiADBuilder(MulticastSourceRdGrouping arg)
Construct a new builder initialized from specifiedMulticastSourceRdGrouping
.SPmsiADBuilder(SPmsiAD base)
Construct a builder initialized with state from specifiedSPmsiAD
.SPmsiADBuilder(OrigRouteIpGrouping arg)
Construct a new builder initialized from specifiedOrigRouteIpGrouping
.SPmsiADBuilder(RouteDistinguisherGrouping arg)
Construct a new builder initialized from specifiedRouteDistinguisherGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SPmsiADBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SPmsiAD> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SPmsiAD>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SPmsiAD
build()
A newSPmsiAD
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MulticastGroup
getMulticastGroup()
Return current value associated with the property corresponding toMulticastGroupOpaqueGrouping.getMulticastGroup()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
getMulticastSource()
Return current value associated with the property corresponding toMulticastSourceRdGrouping.getMulticastSource()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
getOrigRouteIp()
Return current value associated with the property corresponding toOrigRouteIpGrouping.getOrigRouteIp()
.RouteDistinguisher
getRouteDistinguisher()
Return current value associated with the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
.SPmsiADBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SPmsiAD>> augmentationType)
Remove an augmentation from this builder's product.SPmsiADBuilder
setMulticastGroup(MulticastGroup value)
Set the property corresponding toMulticastGroupOpaqueGrouping.getMulticastGroup()
to the specified value.SPmsiADBuilder
setMulticastSource(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
Set the property corresponding toMulticastSourceRdGrouping.getMulticastSource()
to the specified value.SPmsiADBuilder
setOrigRouteIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
Set the property corresponding toOrigRouteIpGrouping.getOrigRouteIp()
to the specified value.SPmsiADBuilder
setRouteDistinguisher(RouteDistinguisher value)
Set the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
to the specified value.
-
-
-
Constructor Detail
-
SPmsiADBuilder
public SPmsiADBuilder()
Construct an empty builder.
-
SPmsiADBuilder
public SPmsiADBuilder(MulticastSourceRdGrouping arg)
Construct a new builder initialized from specifiedMulticastSourceRdGrouping
.- Parameters:
arg
- MulticastSourceRdGrouping from which the builder should be initialized
-
SPmsiADBuilder
public SPmsiADBuilder(RouteDistinguisherGrouping arg)
Construct a new builder initialized from specifiedRouteDistinguisherGrouping
.- Parameters:
arg
- RouteDistinguisherGrouping from which the builder should be initialized
-
SPmsiADBuilder
public SPmsiADBuilder(MulticastGroupOpaqueGrouping arg)
Construct a new builder initialized from specifiedMulticastGroupOpaqueGrouping
.- Parameters:
arg
- MulticastGroupOpaqueGrouping from which the builder should be initialized
-
SPmsiADBuilder
public SPmsiADBuilder(OrigRouteIpGrouping arg)
Construct a new builder initialized from specifiedOrigRouteIpGrouping
.- Parameters:
arg
- OrigRouteIpGrouping 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
-
getMulticastGroup
public MulticastGroup getMulticastGroup()
Return current value associated with the property corresponding toMulticastGroupOpaqueGrouping.getMulticastGroup()
.- Returns:
- current value
-
getMulticastSource
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getMulticastSource()
Return current value associated with the property corresponding toMulticastSourceRdGrouping.getMulticastSource()
.- Returns:
- current value
-
getOrigRouteIp
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getOrigRouteIp()
Return current value associated with the property corresponding toOrigRouteIpGrouping.getOrigRouteIp()
.- Returns:
- current value
-
getRouteDistinguisher
public RouteDistinguisher getRouteDistinguisher()
Return current value associated with the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SPmsiAD>> 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
-
setMulticastGroup
public SPmsiADBuilder setMulticastGroup(MulticastGroup value)
Set the property corresponding toMulticastGroupOpaqueGrouping.getMulticastGroup()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMulticastSource
public SPmsiADBuilder setMulticastSource(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
Set the property corresponding toMulticastSourceRdGrouping.getMulticastSource()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOrigRouteIp
public SPmsiADBuilder setOrigRouteIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
Set the property corresponding toOrigRouteIpGrouping.getOrigRouteIp()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouteDistinguisher
public SPmsiADBuilder setRouteDistinguisher(RouteDistinguisher value)
Set the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SPmsiADBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SPmsiAD> 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 SPmsiADBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SPmsiAD>> 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
-
-