Class CMulticastBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.c.multicast.grouping.CMulticastBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<CMulticast>
,org.opendaylight.yangtools.concepts.CheckedBuilder<CMulticast,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class CMulticastBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<CMulticast>
Class that buildsCMulticastBuilder
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:
CMulticastBuilder createTarget(int fooXyzzy, int barBaz) { return new CMulticastBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of CMulticastBuilder, 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 oportunities, 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:
CMulticastBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description CMulticastBuilder()
CMulticastBuilder(CMulticast base)
CMulticastBuilder(MulticastGroupOpaqueGrouping arg)
CMulticastBuilder(MulticastSourceRdGrouping arg)
CMulticastBuilder(SourceAsGrouping arg)
CMulticastBuilder(RouteDistinguisherGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CMulticastBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<CMulticast> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CMulticast>>
E$$augmentation(Class<E$$> augmentationType)
CMulticast
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MulticastGroup
getMulticastGroup()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
getMulticastSource()
RouteDistinguisher
getRouteDistinguisher()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
getSourceAs()
CMulticastBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CMulticast>> augmentationType)
Remove an augmentation from this builder's product.CMulticastBuilder
setMulticastGroup(MulticastGroup value)
CMulticastBuilder
setMulticastSource(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
CMulticastBuilder
setRouteDistinguisher(RouteDistinguisher value)
CMulticastBuilder
setSourceAs(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
-
-
-
Constructor Detail
-
CMulticastBuilder
public CMulticastBuilder()
-
CMulticastBuilder
public CMulticastBuilder(MulticastSourceRdGrouping arg)
-
CMulticastBuilder
public CMulticastBuilder(RouteDistinguisherGrouping arg)
-
CMulticastBuilder
public CMulticastBuilder(SourceAsGrouping arg)
-
CMulticastBuilder
public CMulticastBuilder(MulticastGroupOpaqueGrouping arg)
-
CMulticastBuilder
public CMulticastBuilder(CMulticast base)
-
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.SourceAsGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.MulticastGroupOpaqueGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.MulticastSourceRdGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.RouteDistinguisherGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getMulticastGroup
public MulticastGroup getMulticastGroup()
-
getMulticastSource
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getMulticastSource()
-
getRouteDistinguisher
public RouteDistinguisher getRouteDistinguisher()
-
getSourceAs
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getSourceAs()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CMulticast>> E$$ augmentation(Class<E$$> augmentationType)
-
setMulticastGroup
public CMulticastBuilder setMulticastGroup(MulticastGroup value)
-
setMulticastSource
public CMulticastBuilder setMulticastSource(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
-
setRouteDistinguisher
public CMulticastBuilder setRouteDistinguisher(RouteDistinguisher value)
-
setSourceAs
public CMulticastBuilder setSourceAs(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
-
addAugmentation
public CMulticastBuilder addAugmentation(org.opendaylight.yangtools.yang.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.yang.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
public CMulticast build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<CMulticast>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<CMulticast,IllegalArgumentException>
-
-