Class CMulticastBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.c.multicast.grouping.CMulticastBuilder
Class that builds
CMulticast
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:
CMulticast createCMulticast(int fooXyzzy, int barBaz) {
return new CMulticastBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of CMulticast, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.CMulticastBuilder
(CMulticast base) Construct a builder initialized with state from specifiedCMulticast
.Construct a new builder initialized from specifiedMulticastGroupOpaqueGrouping
.Construct a new builder initialized from specifiedMulticastSourceRdGrouping
.Construct a new builder initialized from specifiedSourceAsGrouping
.Construct a new builder initialized from specifiedRouteDistinguisherGrouping
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<CMulticast> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<CMulticast>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull CMulticast
build()
A newCMulticast
instance.static @NonNull CMulticast
empty()
Get empty instance of CMulticast.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.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
Return current value associated with the property corresponding toMulticastSourceRdGrouping.getMulticastSource()
.Return current value associated with the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
Return current value associated with the property corresponding toSourceAsGrouping.getSourceAs()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<CMulticast>> augmentationType) Remove an augmentation from this builder's product.setMulticastGroup
(MulticastGroup value) Set the property corresponding toMulticastGroupOpaqueGrouping.getMulticastGroup()
to the specified value.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.Set the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
to the specified value.setSourceAs
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value) Set the property corresponding toSourceAsGrouping.getSourceAs()
to the specified value.
-
Constructor Details
-
CMulticastBuilder
public CMulticastBuilder()Construct an empty builder. -
CMulticastBuilder
Construct a new builder initialized from specifiedMulticastSourceRdGrouping
.- Parameters:
arg
- MulticastSourceRdGrouping from which the builder should be initialized
-
CMulticastBuilder
Construct a new builder initialized from specifiedRouteDistinguisherGrouping
.- Parameters:
arg
- RouteDistinguisherGrouping from which the builder should be initialized
-
CMulticastBuilder
Construct a new builder initialized from specifiedSourceAsGrouping
.- Parameters:
arg
- SourceAsGrouping from which the builder should be initialized
-
CMulticastBuilder
Construct a new builder initialized from specifiedMulticastGroupOpaqueGrouping
.- Parameters:
arg
- MulticastGroupOpaqueGrouping from which the builder should be initialized
-
CMulticastBuilder
Construct a builder initialized with state from specifiedCMulticast
.- Parameters:
base
- CMulticast from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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
-
empty
Get empty instance of CMulticast.- Returns:
- An empty
CMulticast
-
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
-
getRouteDistinguisher
Return current value associated with the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
.- Returns:
- current value
-
getSourceAs
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getSourceAs()Return current value associated with the property corresponding toSourceAsGrouping.getSourceAs()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<CMulticast>> 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
Set the property corresponding toMulticastGroupOpaqueGrouping.getMulticastGroup()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMulticastSource
public CMulticastBuilder 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
-
setRouteDistinguisher
Set the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSourceAs
public CMulticastBuilder setSourceAs(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value) Set the property corresponding toSourceAsGrouping.getSourceAs()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public CMulticastBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<CMulticast> 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 CMulticastBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<CMulticast>> 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
A newCMulticast
instance.- Returns:
- A new
CMulticast
instance.
-