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.ipv4.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>
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(NeighbourIpMulticastAfConfig arg)
MulticastBuilder(SlowPeerConfig arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MulticastBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Multicast>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Multicast> augmentationValue)
<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.org.opendaylight.yangtools.yang.common.Uint32
getAdvertisementInterval()
DefaultOriginate
getDefaultOriginate()
Detection
getDetection()
org.opendaylight.yangtools.yang.common.Uint32
getMaximumPrefix()
java.lang.String
getPrefixList()
RemovePrivateAs
getRemovePrivateAs()
java.lang.String
getRouteServerClientContext()
NeighbourBaseAfConfig.SendCommunity
getSendCommunity()
java.lang.String
getSoo()
SlowPeerConfig.SplitUpdateGroup
getSplitUpdateGroup()
org.opendaylight.yangtools.yang.common.Uint16
getWeight()
java.lang.Boolean
isActive()
java.lang.Boolean
isAllowasIn()
java.lang.Boolean
isNextHopSelf()
java.lang.Boolean
isNextHopUnchanged()
java.lang.Boolean
isPropagateDmzlinkBw()
java.lang.Boolean
isRouteReflectorClient()
java.lang.Boolean
isSoftReconfiguration()
MulticastBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Multicast>> augmentationType)
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.Use {#link setAdvertisementInterval(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.Use {#link setMaximumPrefix(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
setRouteServerClientContext(java.lang.String 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.Use {#link setWeight(Uint16)} instead.MulticastBuilder
setWeight(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
MulticastBuilder
public MulticastBuilder()
-
MulticastBuilder
public MulticastBuilder(NeighbourIpMulticastAfConfig arg)
-
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.NeighbourIpMulticastAfConfig
- 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
-
getAdvertisementInterval
public org.opendaylight.yangtools.yang.common.Uint32 getAdvertisementInterval()
-
getDefaultOriginate
public DefaultOriginate getDefaultOriginate()
-
getDetection
public Detection getDetection()
-
getMaximumPrefix
public org.opendaylight.yangtools.yang.common.Uint32 getMaximumPrefix()
-
getPrefixList
public java.lang.String getPrefixList()
-
getRemovePrivateAs
public RemovePrivateAs getRemovePrivateAs()
-
getRouteServerClientContext
public java.lang.String getRouteServerClientContext()
-
getSendCommunity
public NeighbourBaseAfConfig.SendCommunity getSendCommunity()
-
getSoo
public java.lang.String getSoo()
-
getSplitUpdateGroup
public SlowPeerConfig.SplitUpdateGroup getSplitUpdateGroup()
-
getWeight
public org.opendaylight.yangtools.yang.common.Uint16 getWeight()
-
isActive
public java.lang.Boolean isActive()
-
isAllowasIn
public java.lang.Boolean isAllowasIn()
-
isNextHopSelf
public java.lang.Boolean isNextHopSelf()
-
isNextHopUnchanged
public java.lang.Boolean isNextHopUnchanged()
-
isPropagateDmzlinkBw
public java.lang.Boolean isPropagateDmzlinkBw()
-
isRouteReflectorClient
public java.lang.Boolean isRouteReflectorClient()
-
isSoftReconfiguration
public java.lang.Boolean isSoftReconfiguration()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Multicast>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
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.Use {#link setAdvertisementInterval(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
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.Use {#link setMaximumPrefix(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setPrefixList
public MulticastBuilder setPrefixList(java.lang.String value)
-
setRemovePrivateAs
public MulticastBuilder setRemovePrivateAs(RemovePrivateAs value)
-
setRouteServerClientContext
public MulticastBuilder setRouteServerClientContext(java.lang.String value)
-
setSendCommunity
public MulticastBuilder setSendCommunity(NeighbourBaseAfConfig.SendCommunity 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.Use {#link setWeight(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setActive
public MulticastBuilder setActive(java.lang.Boolean value)
-
setAllowasIn
public MulticastBuilder setAllowasIn(java.lang.Boolean value)
-
setNextHopSelf
public MulticastBuilder setNextHopSelf(java.lang.Boolean value)
-
setNextHopUnchanged
public MulticastBuilder setNextHopUnchanged(java.lang.Boolean value)
-
setPropagateDmzlinkBw
public MulticastBuilder setPropagateDmzlinkBw(java.lang.Boolean value)
-
setRouteReflectorClient
public MulticastBuilder setRouteReflectorClient(java.lang.Boolean value)
-
setSoftReconfiguration
public MulticastBuilder setSoftReconfiguration(java.lang.Boolean value)
-
addAugmentation
public MulticastBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Multicast>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Multicast> augmentationValue)
-
removeAugmentation
public MulticastBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Multicast>> augmentationType)
-
-