Class MulticastBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.neighbors.bgp.neighbor.af.specific.config.vpnv6.MulticastBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Multicast>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Multicast,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MulticastBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Multicast>
Class that buildsMulticastBuilder
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:
MulticastBuilder createTarget(int fooXyzzy, int barBaz) { return new MulticastBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MulticastBuilder, 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:
MulticastBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MulticastBuilder()
MulticastBuilder(Multicast base)
MulticastBuilder(NeighbourBaseAfConfig arg)
MulticastBuilder(NeighbourCastAfConfig arg)
MulticastBuilder(NeighbourCommonAfConfig arg)
MulticastBuilder(SlowPeerConfig arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MulticastBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Multicast> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Multicast>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Multicast
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.java.lang.Boolean
getActive()
org.opendaylight.yangtools.yang.common.Uint32
getAdvertisementInterval()
java.lang.Boolean
getAllowasIn()
DefaultOriginate
getDefaultOriginate()
Detection
getDetection()
org.opendaylight.yangtools.yang.common.Uint32
getMaximumPrefix()
java.lang.Boolean
getNextHopSelf()
java.lang.Boolean
getNextHopUnchanged()
java.lang.String
getPrefixList()
java.lang.Boolean
getPropagateDmzlinkBw()
RemovePrivateAs
getRemovePrivateAs()
java.lang.Boolean
getRouteReflectorClient()
NeighbourBaseAfConfig.SendCommunity
getSendCommunity()
java.lang.Boolean
getSoftReconfiguration()
java.lang.String
getSoo()
SlowPeerConfig.SplitUpdateGroup
getSplitUpdateGroup()
org.opendaylight.yangtools.yang.common.Uint16
getWeight()
java.lang.Boolean
isActive()
Deprecated, for removal: This API element is subject to removal in a future version.java.lang.Boolean
isAllowasIn()
Deprecated, for removal: This API element is subject to removal in a future version.java.lang.Boolean
isNextHopSelf()
Deprecated, for removal: This API element is subject to removal in a future version.java.lang.Boolean
isNextHopUnchanged()
Deprecated, for removal: This API element is subject to removal in a future version.java.lang.Boolean
isPropagateDmzlinkBw()
Deprecated, for removal: This API element is subject to removal in a future version.java.lang.Boolean
isRouteReflectorClient()
Deprecated, for removal: This API element is subject to removal in a future version.java.lang.Boolean
isSoftReconfiguration()
Deprecated, for removal: This API element is subject to removal in a future version.MulticastBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Multicast>> augmentationType)
Remove an augmentation from this builder's product.MulticastBuilder
setActive(java.lang.Boolean value)
MulticastBuilder
setAdvertisementInterval(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAdvertisementInterval(Uint32)
instead.MulticastBuilder
setAdvertisementInterval(org.opendaylight.yangtools.yang.common.Uint32 value)
MulticastBuilder
setAllowasIn(java.lang.Boolean value)
MulticastBuilder
setDefaultOriginate(DefaultOriginate value)
MulticastBuilder
setDetection(Detection value)
MulticastBuilder
setMaximumPrefix(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMaximumPrefix(Uint32)
instead.MulticastBuilder
setMaximumPrefix(org.opendaylight.yangtools.yang.common.Uint32 value)
MulticastBuilder
setNextHopSelf(java.lang.Boolean value)
MulticastBuilder
setNextHopUnchanged(java.lang.Boolean value)
MulticastBuilder
setPrefixList(java.lang.String value)
MulticastBuilder
setPropagateDmzlinkBw(java.lang.Boolean value)
MulticastBuilder
setRemovePrivateAs(RemovePrivateAs value)
MulticastBuilder
setRouteReflectorClient(java.lang.Boolean value)
MulticastBuilder
setSendCommunity(NeighbourBaseAfConfig.SendCommunity value)
MulticastBuilder
setSoftReconfiguration(java.lang.Boolean value)
MulticastBuilder
setSoo(java.lang.String value)
MulticastBuilder
setSplitUpdateGroup(SlowPeerConfig.SplitUpdateGroup value)
MulticastBuilder
setWeight(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetWeight(Uint16)
instead.MulticastBuilder
setWeight(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
MulticastBuilder
public MulticastBuilder()
-
MulticastBuilder
public MulticastBuilder(NeighbourCastAfConfig arg)
-
MulticastBuilder
public MulticastBuilder(NeighbourCommonAfConfig arg)
-
MulticastBuilder
public MulticastBuilder(NeighbourBaseAfConfig arg)
-
MulticastBuilder
public MulticastBuilder(SlowPeerConfig arg)
-
MulticastBuilder
public MulticastBuilder(Multicast 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.cisco.params.xml.ns.yang.bgp.rev130715.NeighbourCastAfConfig
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.SlowPeerConfig
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.NeighbourBaseAfConfig
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.NeighbourCommonAfConfig
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getActive
public java.lang.Boolean getActive()
-
isActive
@Deprecated(forRemoval=true) public final java.lang.Boolean isActive()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getAdvertisementInterval
public org.opendaylight.yangtools.yang.common.Uint32 getAdvertisementInterval()
-
getAllowasIn
public java.lang.Boolean getAllowasIn()
-
isAllowasIn
@Deprecated(forRemoval=true) public final java.lang.Boolean isAllowasIn()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getDefaultOriginate
public DefaultOriginate getDefaultOriginate()
-
getDetection
public Detection getDetection()
-
getMaximumPrefix
public org.opendaylight.yangtools.yang.common.Uint32 getMaximumPrefix()
-
getNextHopSelf
public java.lang.Boolean getNextHopSelf()
-
isNextHopSelf
@Deprecated(forRemoval=true) public final java.lang.Boolean isNextHopSelf()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getNextHopUnchanged
public java.lang.Boolean getNextHopUnchanged()
-
isNextHopUnchanged
@Deprecated(forRemoval=true) public final java.lang.Boolean isNextHopUnchanged()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getPrefixList
public java.lang.String getPrefixList()
-
getPropagateDmzlinkBw
public java.lang.Boolean getPropagateDmzlinkBw()
-
isPropagateDmzlinkBw
@Deprecated(forRemoval=true) public final java.lang.Boolean isPropagateDmzlinkBw()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getRemovePrivateAs
public RemovePrivateAs getRemovePrivateAs()
-
getRouteReflectorClient
public java.lang.Boolean getRouteReflectorClient()
-
isRouteReflectorClient
@Deprecated(forRemoval=true) public final java.lang.Boolean isRouteReflectorClient()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getSendCommunity
public NeighbourBaseAfConfig.SendCommunity getSendCommunity()
-
getSoftReconfiguration
public java.lang.Boolean getSoftReconfiguration()
-
isSoftReconfiguration
@Deprecated(forRemoval=true) public final java.lang.Boolean isSoftReconfiguration()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getSoo
public java.lang.String getSoo()
-
getSplitUpdateGroup
public SlowPeerConfig.SplitUpdateGroup getSplitUpdateGroup()
-
getWeight
public org.opendaylight.yangtools.yang.common.Uint16 getWeight()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Multicast>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setActive
public MulticastBuilder setActive(java.lang.Boolean value)
-
setAdvertisementInterval
public MulticastBuilder setAdvertisementInterval(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setAdvertisementInterval
@Deprecated(forRemoval=true) public MulticastBuilder setAdvertisementInterval(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAdvertisementInterval(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setAllowasIn
public MulticastBuilder setAllowasIn(java.lang.Boolean value)
-
setDefaultOriginate
public MulticastBuilder setDefaultOriginate(DefaultOriginate value)
-
setDetection
public MulticastBuilder setDetection(Detection value)
-
setMaximumPrefix
public MulticastBuilder setMaximumPrefix(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMaximumPrefix
@Deprecated(forRemoval=true) public MulticastBuilder setMaximumPrefix(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMaximumPrefix(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setNextHopSelf
public MulticastBuilder setNextHopSelf(java.lang.Boolean value)
-
setNextHopUnchanged
public MulticastBuilder setNextHopUnchanged(java.lang.Boolean value)
-
setPrefixList
public MulticastBuilder setPrefixList(java.lang.String value)
-
setPropagateDmzlinkBw
public MulticastBuilder setPropagateDmzlinkBw(java.lang.Boolean value)
-
setRemovePrivateAs
public MulticastBuilder setRemovePrivateAs(RemovePrivateAs value)
-
setRouteReflectorClient
public MulticastBuilder setRouteReflectorClient(java.lang.Boolean value)
-
setSendCommunity
public MulticastBuilder setSendCommunity(NeighbourBaseAfConfig.SendCommunity value)
-
setSoftReconfiguration
public MulticastBuilder setSoftReconfiguration(java.lang.Boolean value)
-
setSoo
public MulticastBuilder setSoo(java.lang.String value)
-
setSplitUpdateGroup
public MulticastBuilder setSplitUpdateGroup(SlowPeerConfig.SplitUpdateGroup value)
-
setWeight
public MulticastBuilder setWeight(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setWeight
@Deprecated(forRemoval=true) public MulticastBuilder setWeight(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetWeight(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public MulticastBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Multicast> 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 MulticastBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Multicast>> 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
-
-